BigQuery Data Transfer API (bigquerydatatransfer:v1)

2022-06-11

32 new methods | New API

Additions

    Methods
  • bigquerydatatransfer.projects.enrollDataSources

      Parameters:

        name

          Required: Yes

          Pattern: ^projects/[^/]+$

          Description: The name of the project resource in the form: `projects/{project_id}`

          Type: string

          Location: path

      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).

      Parameter Order: name

      HTTP Method: POST

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • Path: v1/{+name}:enrollDataSources

      Flat Path: v1/projects/{projectsId}:enrollDataSources

  • bigquerydatatransfer.projects.dataSources.list

      Path: v1/{+parent}/dataSources

      Flat Path: v1/projects/{projectsId}/dataSources

      Parameter Order: parent

      Parameters:

        parent

          Type: string

          Pattern: ^projects/[^/]+$

          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}`

        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

          Format: int32

          Type: integer

          Description: Page size. The default page size is the maximum value of 1000 results.

          Location: query

      HTTP Method: GET

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Description: Lists supported data sources and returns their settings.

  • bigquerydatatransfer.projects.dataSources.get

  • bigquerydatatransfer.projects.dataSources.checkValidCreds

  • bigquerydatatransfer.projects.transferConfigs.patch

      Description: Updates a data transfer configuration. All fields must be set, even if they are not updated.

      Parameter Order: name

      HTTP Method: PATCH

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameters:

        name

          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.

          Location: path

          Required: Yes

          Pattern: ^projects/[^/]+/transferConfigs/[^/]+$

        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

        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? client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * 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

          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? client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * 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

          Location: query

        updateMask

          Format: google-fieldmask

          Description: Required. Required list of fields to be updated in this request.

          Location: query

          Type: string

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}

  • bigquerydatatransfer.projects.transferConfigs.scheduleRuns

      Parameter Order: parent

      HTTP Method: POST

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • Flat Path: v1/projects/{projectsId}/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

          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/[^/]+$

          Type: string

          Required: Yes

          Location: path

      Path: v1/{+parent}:scheduleRuns

  • bigquerydatatransfer.projects.transferConfigs.startManualRuns

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • HTTP Method: POST

      Parameter Order: parent

      Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:startManualRuns

      Path: v1/{+parent}:startManualRuns

      Parameters:

        parent

          Location: path

          Pattern: ^projects/[^/]+/transferConfigs/[^/]+$

          Description: Transfer configuration name in the form: `projects/{project_id}/transferConfigs/{config_id}` or `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`.

          Required: Yes

          Type: string

      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

      Path: v1/{+parent}/transferConfigs

      Parameter Order: parent

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Description: Returns information about all transfer configs owned by a project in the specified location.

      HTTP Method: GET

      Parameters:

        parent

          Required: Yes

          Pattern: ^projects/[^/]+$

          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}`

        dataSourceIds

          Description: When specified, only configurations of requested data sources are returned.

          Location: query

          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

        pageSize

          Format: int32

          Type: integer

          Location: query

          Description: Page size. The default page size is the maximum value of 1000 results.

      Flat Path: v1/projects/{projectsId}/transferConfigs

  • bigquerydatatransfer.projects.transferConfigs.get

  • bigquerydatatransfer.projects.transferConfigs.delete

      HTTP Method: DELETE

      Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}

      Parameters:

        name

          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}`

          Location: path

          Type: string

      Description: Deletes a data transfer configuration, including any associated transfer runs and logs.

      Parameter Order: name

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • Path: v1/{+name}

  • bigquerydatatransfer.projects.transferConfigs.create

      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).

        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? client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * 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

          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? client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * 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

          Location: path

          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.

          Type: string

          Required: Yes

      Parameter Order: parent

      Description: Creates a new data transfer configuration.

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Path: v1/{+parent}/transferConfigs

      Flat Path: v1/projects/{projectsId}/transferConfigs

      HTTP Method: POST

  • bigquerydatatransfer.projects.transferConfigs.runs.list

      Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs

      Description: Returns information about running and completed transfer runs.

      HTTP Method: GET

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Parameter Order: parent

      Path: v1/{+parent}/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

        pageSize

          Format: int32

          Location: query

          Description: Page size. The default page size is the maximum value of 1000 results.

          Type: integer

        parent

          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}`.

          Pattern: ^projects/[^/]+/transferConfigs/[^/]+$

          Location: path

          Required: Yes

          Type: string

        states

          Description: When specified, only transfer runs with requested states are returned.

          Location: query

          Enum:

        • TRANSFER_STATE_UNSPECIFIED
        • PENDING
        • RUNNING
        • SUCCEEDED
        • FAILED
        • CANCELLED
        • Enum Descriptions:

        • State placeholder (0).
        • Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).
        • Data transfer is in progress (3).
        • Data transfer completed successfully (4).
        • Data transfer failed (5).
        • Data transfer is cancelled (6).
        • Type: string

          Repeated: Yes

        runAttempt

          Location: query

          Enum:

        • RUN_ATTEMPT_UNSPECIFIED
        • LATEST
        • Type: string

          Description: Indicates how run attempts are to be pulled.

          Enum Descriptions:

        • All runs should be returned.
        • Only latest run per day should be returned.

  • bigquerydatatransfer.projects.transferConfigs.runs.get

      Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}

      Description: Returns information about the particular transfer run.

      Parameter Order: name

      Parameters:

        name

          Pattern: ^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$

          Location: path

          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}`

      HTTP Method: 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}

  • bigquerydatatransfer.projects.transferConfigs.runs.delete

      Parameter Order: name

      HTTP Method: DELETE

      Description: Deletes the specified transfer run.

      Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • Parameters:

        name

          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}`

          Location: path

          Required: Yes

          Pattern: ^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$

      Path: v1/{+name}

  • bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list

      Description: Returns log messages for the transfer run.

      Path: v1/{+parent}/transferLogs

      Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs

      Parameter Order: parent

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • HTTP Method: GET

      Parameters:

        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

          Description: Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.

          Enum:

        • MESSAGE_SEVERITY_UNSPECIFIED
        • INFO
        • WARNING
        • ERROR
        • Type: string

          Location: query

          Enum Descriptions:

        • No severity specified.
        • Informational message.
        • Warning message.
        • Error message.
        • Repeated: Yes

        pageSize

          Description: Page size. The default page size is the maximum value of 1000 results.

          Type: integer

          Format: int32

          Location: query

        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

  • bigquerydatatransfer.projects.locations.get

  • bigquerydatatransfer.projects.locations.list

      Path: v1/{+name}/locations

      HTTP Method: GET

      Flat Path: v1/projects/{projectsId}/locations

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Parameter Order: name

      Parameters:

        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

          Format: int32

          Description: The maximum number of results to return. If not set, the service selects a default.

          Type: integer

          Location: query

        name

          Required: Yes

          Pattern: ^projects/[^/]+$

          Location: path

          Description: The resource that owns the locations collection, if applicable.

          Type: string

        filter

          Type: string

          Description: A filter to narrow down results to a preferred subset. The filtering language accepts strings like `"displayName=tokyo"`, and is documented in more detail in [AIP-160](https://google.aip.dev/160).

          Location: query

      Description: Lists information about the supported locations for this service.

  • bigquerydatatransfer.projects.locations.enrollDataSources

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • HTTP Method: POST

      Parameters:

        name

          Location: path

          Required: Yes

          Description: The name of the project resource in the form: `projects/{project_id}`

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+$

      Path: v1/{+name}:enrollDataSources

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}:enrollDataSources

      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).

  • bigquerydatatransfer.projects.locations.dataSources.list

      Parameters:

        pageToken

          Description: Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.

          Location: query

          Type: string

        parent

          Description: Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`

          Required: Yes

          Type: string

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+$

        pageSize

          Location: query

          Format: int32

          Description: Page size. The default page size is the maximum value of 1000 results.

          Type: integer

      Description: Lists supported data sources and returns their settings.

      Parameter Order: parent

      HTTP Method: GET

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataSources

      Path: v1/{+parent}/dataSources

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
  • bigquerydatatransfer.projects.locations.dataSources.checkValidCreds

      Path: v1/{+name}:checkValidCreds

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Parameters:

        name

          Pattern: ^projects/[^/]+/locations/[^/]+/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

          Type: string

          Location: path

      Description: Returns true if valid credentials exist for the given data source and requesting user.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}:checkValidCreds

      Parameter Order: name

      HTTP Method: POST

  • 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
    • Parameter Order: name

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}

      Parameters:

        name

          Required: Yes

          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}`

          Pattern: ^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$

          Type: string

      HTTP Method: GET

      Path: v1/{+name}

      Description: Retrieves a supported data source and returns its settings.

  • bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list

      Path: v1/{+parent}/transferLogs

      Parameter Order: parent

      HTTP Method: GET

      Description: Returns log messages for the transfer run.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Parameters:

        pageSize

          Description: Page size. The default page size is the maximum value of 1000 results.

          Format: int32

          Type: integer

          Location: query

        messageTypes

          Repeated: Yes

          Location: query

          Description: Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.

          Type: string

          Enum Descriptions:

        • No severity specified.
        • Informational message.
        • Warning message.
        • Error message.
        • Enum:

        • MESSAGE_SEVERITY_UNSPECIFIED
        • INFO
        • WARNING
        • ERROR

        parent

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$

          Required: Yes

          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}`

        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.

  • bigquerydatatransfer.projects.locations.transferConfigs.runs.list

      Description: Returns information about running and completed transfer runs.

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs

      Parameter Order: parent

      Parameters:

        states

          Enum Descriptions:

        • State placeholder (0).
        • Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).
        • Data transfer is in progress (3).
        • Data transfer completed successfully (4).
        • Data transfer failed (5).
        • Data transfer is cancelled (6).
        • Location: query

          Repeated: Yes

          Description: When specified, only transfer runs with requested states are returned.

          Type: string

          Enum:

        • TRANSFER_STATE_UNSPECIFIED
        • PENDING
        • RUNNING
        • SUCCEEDED
        • FAILED
        • CANCELLED

        runAttempt

          Enum Descriptions:

        • All runs should be returned.
        • Only latest run per day should be returned.
        • Type: string

          Description: Indicates how run attempts are to be pulled.

          Location: query

          Enum:

        • RUN_ATTEMPT_UNSPECIFIED
        • LATEST

        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

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$

          Type: string

          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

          Description: Page size. The default page size is the maximum value of 1000 results.

          Location: query

          Type: integer

          Format: int32

      HTTP Method: GET

      Path: v1/{+parent}/runs

  • bigquerydatatransfer.projects.locations.transferConfigs.runs.get

      Description: Returns information about the particular transfer run.

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Parameter Order: name

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}

      Parameters:

        name

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$

          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

      HTTP Method: GET

      Path: v1/{+name}

  • bigquerydatatransfer.projects.locations.transferConfigs.runs.delete

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}

      Path: v1/{+name}

      HTTP Method: DELETE

      Description: Deletes the specified transfer run.

      Parameters:

        name

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$

          Location: path

          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}`

      Parameter Order: name

  • 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.

      HTTP Method: DELETE

      Parameters:

        name

          Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$

          Location: path

          Type: string

          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}`

          Required: Yes

      Parameter Order: name

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}

  • bigquerydatatransfer.projects.locations.transferConfigs.get

      Parameters:

        name

          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

          Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$

      Path: v1/{+name}

      HTTP Method: GET

      Parameter Order: name

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Description: Returns information about a data transfer config.

  • bigquerydatatransfer.projects.locations.transferConfigs.startManualRuns

      Path: v1/{+parent}:startManualRuns

      Parameter Order: parent

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:startManualRuns

      Parameters:

        parent

          Type: string

          Required: Yes

          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/[^/]+$

      HTTP Method: POST

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • 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.transferConfigs.create

      Path: v1/{+parent}/transferConfigs

      Parameter Order: parent

      Scopes: https://www.googleapis.com/auth/cloud-platform

      HTTP Method: POST

      Description: Creates a new data transfer configuration.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs

      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? client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * 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.

        parent

          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

          Location: path

        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? client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * 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

  • bigquerydatatransfer.projects.locations.transferConfigs.patch

      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

      Parameters:

        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? client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * 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

          Location: query

        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

          Location: path

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$

        serviceAccountName

          Type: string

          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).

        updateMask

          Description: Required. Required list of fields to be updated in this request.

          Format: google-fieldmask

          Location: query

          Type: string

        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? client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * 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

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}

      HTTP Method: PATCH

      Parameter Order: name

  • bigquerydatatransfer.projects.locations.transferConfigs.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.

      Parameter Order: parent

      HTTP Method: POST

      Parameters:

        parent

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$

          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

          Required: Yes

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • Path: v1/{+parent}:scheduleRuns

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:scheduleRuns

  • bigquerydatatransfer.projects.locations.transferConfigs.list

      Path: v1/{+parent}/transferConfigs

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Description: Returns information about all transfer configs owned by a project in the specified location.

      Parameters:

        parent

          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}`

          Pattern: ^projects/[^/]+/locations/[^/]+$

        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

        dataSourceIds

          Repeated: Yes

          Type: string

          Location: query

          Description: When specified, only configurations of requested data sources are returned.

        pageSize

          Format: int32

          Description: Page size. The default page size is the maximum value of 1000 results.

          Location: query

          Type: integer

      Parameter Order: parent

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs

      HTTP Method: GET

32 removed methods | Removed API

Deletions

    Methods
  • bigquerydatatransfer.projects.locations.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.

      Parameter Order: parent

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs

      HTTP Method: GET

      Parameters:

        parent

          Required: Yes

          Type: string

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$

          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}`

        messageTypes

          Type: string

          Location: query

          Repeated: Yes

          Description: Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.

          Enum:

        • MESSAGE_SEVERITY_UNSPECIFIED
        • INFO
        • WARNING
        • ERROR
        • Enum Descriptions:

        • No severity specified.
        • Informational message.
        • Warning message.
        • Error message.

        pageSize

          Description: Page size. The default page size is the maximum value of 1000 results.

          Type: integer

          Format: int32

          Location: query

        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

  • bigquerydatatransfer.projects.locations.transferConfigs.runs.list

      Description: Returns information about running and completed transfer runs.

      Parameter Order: parent

      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

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs

      HTTP Method: GET

      Parameters:

        states

          Enum Descriptions:

        • 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).
        • Description: When specified, only transfer runs with requested states are returned.

          Location: query

          Repeated: Yes

          Type: string

          Enum:

        • TRANSFER_STATE_UNSPECIFIED
        • PENDING
        • RUNNING
        • SUCCEEDED
        • FAILED
        • CANCELLED

        pageSize

          Description: Page size. The default page size is the maximum value of 1000 results.

          Location: query

          Type: integer

          Format: int32

        runAttempt

          Enum Descriptions:

        • All runs should be returned.
        • Only latest run per day should be returned.
        • Description: Indicates how run attempts are to be pulled.

          Type: string

          Enum:

        • RUN_ATTEMPT_UNSPECIFIED
        • LATEST
        • Location: query

        parent

          Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$

          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}`.

          Required: Yes

          Type: string

        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.

  • bigquerydatatransfer.projects.locations.transferConfigs.runs.get

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Parameter Order: name

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}

      Path: v1/{+name}

      HTTP Method: GET

      Description: Returns information about the particular transfer run.

      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/[^/]+$

          Type: string

          Required: Yes

  • bigquerydatatransfer.projects.locations.transferConfigs.runs.delete

      Parameter Order: name

      Description: Deletes the specified transfer run.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}

      Parameters:

        name

          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}`

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$

          Required: Yes

      Path: v1/{+name}

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • HTTP Method: DELETE

  • bigquerydatatransfer.projects.locations.transferConfigs.startManualRuns

      HTTP Method: POST

      Parameter Order: parent

      Parameters:

        parent

          Description: 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/[^/]+$

          Type: string

          Location: path

      Path: v1/{+parent}:startManualRuns

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:startManualRuns

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • 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.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
    • Parameters:

        dataSourceIds

          Type: string

          Location: query

          Repeated: Yes

          Description: When specified, only configurations of requested data sources are returned.

        pageToken

          Location: query

          Description: Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.

          Type: string

        pageSize

          Format: int32

          Description: Page size. The default page size is the maximum value of 1000 results.

          Location: query

          Type: integer

        parent

          Type: string

          Required: Yes

          Pattern: ^projects/[^/]+/locations/[^/]+$

          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

      Parameter Order: parent

      Description: Returns information about all transfer configs owned by a project in the specified location.

      HTTP Method: GET

      Path: v1/{+parent}/transferConfigs

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs

  • bigquerydatatransfer.projects.locations.transferConfigs.create

      Path: v1/{+parent}/transferConfigs

      Parameters:

        serviceAccountName

          Type: string

          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).

        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? client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * 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

        parent

          Required: Yes

          Location: path

          Type: string

          Description: Required. The BigQuery project id where the transfer configuration should be created. Must be in the format projects/{project_id}/locations/{location_id} or projects/{project_id}. If specified location and location of the destination bigquery dataset do not match - the request will fail.

          Pattern: ^projects/[^/]+/locations/[^/]+$

        versionInfo

          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? client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * 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

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Description: Creates a new data transfer configuration.

      Parameter Order: parent

      HTTP Method: POST

  • bigquerydatatransfer.projects.locations.transferConfigs.delete

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • Parameter Order: name

      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}`

          Required: Yes

          Type: string

          Location: path

      Description: Deletes a data transfer configuration, including any associated transfer runs and logs.

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}

      Path: v1/{+name}

      HTTP Method: DELETE

  • bigquerydatatransfer.projects.locations.transferConfigs.get

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}

      HTTP Method: GET

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Description: Returns information about a data transfer config.

      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}`

          Required: Yes

          Type: string

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$

      Path: v1/{+name}

      Parameter Order: name

  • bigquerydatatransfer.projects.locations.transferConfigs.patch

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}

      HTTP Method: PATCH

      Path: v1/{+name}

      Parameters:

        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? client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * 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

          Location: query

        updateMask

          Description: Required. Required list of fields to be updated in this request.

          Format: google-fieldmask

          Type: string

          Location: query

        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? client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * 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

        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

        name

          Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$

          Location: path

          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

          Required: Yes

      Description: Updates a data transfer configuration. All fields must be set, even if they are not updated.

      Parameter Order: name

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns

      HTTP Method: POST

      Parameter Order: parent

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • Path: v1/{+parent}:scheduleRuns

      Flat Path: v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:scheduleRuns

      Parameters:

        parent

          Pattern: ^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$

          Location: path

          Type: string

          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}`.

      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.

  • bigquerydatatransfer.projects.locations.dataSources.checkValidCreds

      Path: v1/{+name}:checkValidCreds

      HTTP Method: POST

      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.

      Parameter Order: name

      Parameters:

        name

          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}`.

          Pattern: ^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$

          Required: Yes

          Location: path

          Type: string

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
  • bigquerydatatransfer.projects.locations.dataSources.get

      Parameter Order: name

      Description: Retrieves a supported data source and returns its settings.

      Parameters:

        name

          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}`

          Type: string

          Location: path

          Pattern: ^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$

      Path: v1/{+name}

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}

      HTTP Method: GET

  • bigquerydatatransfer.projects.locations.dataSources.list

      Parameters:

        pageSize

          Format: int32

          Location: query

          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}`

          Location: path

          Required: Yes

          Type: string

          Pattern: ^projects/[^/]+/locations/[^/]+$

        pageToken

          Description: Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.

          Type: string

          Location: query

      Parameter Order: parent

      HTTP Method: GET

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Flat Path: v1/projects/{projectsId}/locations/{locationsId}/dataSources

      Path: v1/{+parent}/dataSources

      Description: Lists supported data sources and returns their settings.

  • bigquerydatatransfer.projects.locations.enrollDataSources

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • Flat Path: v1/projects/{projectsId}/locations/{locationsId}:enrollDataSources

      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).

      HTTP Method: POST

      Path: v1/{+name}:enrollDataSources

      Parameters:

        name

          Type: string

          Required: Yes

          Location: path

          Description: The name of the project resource in the form: `projects/{project_id}`

          Pattern: ^projects/[^/]+/locations/[^/]+$

  • bigquerydatatransfer.projects.locations.list

      Parameter Order: name

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • 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).

          Location: query

          Type: string

        pageSize

          Type: integer

          Format: int32

          Location: query

          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

        name

          Pattern: ^projects/[^/]+$

          Description: The resource that owns the locations collection, if applicable.

          Type: string

          Location: path

          Required: Yes

      HTTP Method: GET

      Path: v1/{+name}/locations

      Description: Lists information about the supported locations for this service.

      Flat Path: v1/projects/{projectsId}/locations

  • bigquerydatatransfer.projects.locations.get

  • bigquerydatatransfer.projects.dataSources.list

      Description: Lists supported data sources and returns their settings.

      Path: v1/{+parent}/dataSources

      Parameters:

        parent

          Description: Required. The BigQuery project id for which data sources should be returned. Must be in the form: `projects/{project_id}` or `projects/{project_id}/locations/{location_id}`

          Required: Yes

          Pattern: ^projects/[^/]+$

          Location: path

          Type: string

        pageSize

          Type: integer

          Format: int32

          Description: Page size. The default page size is the maximum value of 1000 results.

          Location: query

        pageToken

          Description: Pagination token, which can be used to request a specific page of `ListDataSourcesRequest` list results. For multiple-page results, `ListDataSourcesResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.

          Location: query

          Type: string

      HTTP Method: GET

      Parameter Order: parent

      Flat Path: v1/projects/{projectsId}/dataSources

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
  • bigquerydatatransfer.projects.dataSources.checkValidCreds

  • bigquerydatatransfer.projects.dataSources.get

  • bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list

      Parameters:

        messageTypes

          Description: Message types to return. If not populated - INFO, WARNING and ERROR messages are returned.

          Location: query

          Enum:

        • MESSAGE_SEVERITY_UNSPECIFIED
        • INFO
        • WARNING
        • ERROR
        • Type: string

          Enum Descriptions:

        • No severity specified.
        • Informational message.
        • Warning message.
        • Error message.
        • Repeated: 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.

          Format: int32

          Type: integer

          Location: query

        parent

          Required: Yes

          Pattern: ^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$

          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}`

          Type: string

          Location: path

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs

      Path: v1/{+parent}/transferLogs

      Parameter Order: parent

      Description: Returns log messages for the transfer run.

      HTTP Method: GET

  • bigquerydatatransfer.projects.transferConfigs.runs.delete

      HTTP Method: DELETE

      Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}

      Path: v1/{+name}

      Parameter Order: name

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • Description: Deletes the specified transfer run.

      Parameters:

        name

          Location: path

          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}`

  • bigquerydatatransfer.projects.transferConfigs.runs.get

      Path: v1/{+name}

      Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}

      HTTP Method: GET

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Parameter Order: name

      Parameters:

        name

          Location: path

          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/[^/]+/transferConfigs/[^/]+/runs/[^/]+$

          Type: string

          Required: Yes

      Description: Returns information about the particular transfer run.

  • bigquerydatatransfer.projects.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
    • Parameters:

        states

          Enum:

        • TRANSFER_STATE_UNSPECIFIED
        • PENDING
        • RUNNING
        • SUCCEEDED
        • FAILED
        • CANCELLED
        • Location: query

          Type: string

          Enum Descriptions:

        • State placeholder (0).
        • Data transfer is scheduled and is waiting to be picked up by data transfer backend (2).
        • Data transfer is in progress (3).
        • Data transfer completed successfully (4).
        • Data transfer failed (5).
        • Data transfer is cancelled (6).
        • Repeated: Yes

          Description: When specified, only transfer runs with requested states are returned.

        pageToken

          Location: query

          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.

        pageSize

          Location: query

          Description: Page size. The default page size is the maximum value of 1000 results.

          Format: int32

          Type: integer

        parent

          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}`.

          Pattern: ^projects/[^/]+/transferConfigs/[^/]+$

          Required: Yes

          Location: path

          Type: string

        runAttempt

          Location: query

          Type: string

          Enum:

        • RUN_ATTEMPT_UNSPECIFIED
        • LATEST
        • Enum Descriptions:

        • All runs should be returned.
        • Only latest run per day should be returned.
        • Description: Indicates how run attempts are to be pulled.

      HTTP Method: GET

      Description: Returns information about running and completed transfer runs.

      Parameter Order: parent

      Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs

      Path: v1/{+parent}/runs

  • bigquerydatatransfer.projects.transferConfigs.startManualRuns

      Parameters:

        parent

          Required: Yes

          Location: path

          Pattern: ^projects/[^/]+/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

      Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:startManualRuns

      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.

      Path: v1/{+parent}:startManualRuns

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • HTTP Method: POST

      Parameter Order: parent

  • bigquerydatatransfer.projects.transferConfigs.delete

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}

      Path: v1/{+name}

      Parameter Order: name

      HTTP Method: DELETE

      Description: Deletes a data transfer configuration, including any associated transfer runs and logs.

      Parameters:

        name

          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}`

          Type: string

  • bigquerydatatransfer.projects.transferConfigs.create

      Parameter Order: parent

      Path: v1/{+parent}/transferConfigs

      Flat Path: v1/projects/{projectsId}/transferConfigs

      Description: Creates a new data transfer configuration.

      Parameters:

        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? client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * 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

        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

        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? client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * 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

        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.

          Required: Yes

          Location: path

          Pattern: ^projects/[^/]+$

          Type: string

      HTTP Method: POST

      Scopes: https://www.googleapis.com/auth/cloud-platform

  • bigquerydatatransfer.projects.transferConfigs.scheduleRuns

      Parameter Order: parent

      Parameters:

        parent

          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/[^/]+$

          Type: string

          Required: Yes

          Location: path

      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.

      Path: v1/{+parent}:scheduleRuns

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • HTTP Method: POST

      Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns

  • bigquerydatatransfer.projects.transferConfigs.get

  • bigquerydatatransfer.projects.transferConfigs.patch

      Flat Path: v1/projects/{projectsId}/transferConfigs/{transferConfigsId}

      Scopes: https://www.googleapis.com/auth/cloud-platform

      Parameter Order: name

      Path: v1/{+name}

      HTTP Method: PATCH

      Parameters:

        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

        updateMask

          Description: Required. Required list of fields to be updated in this request.

          Type: string

          Format: google-fieldmask

          Location: query

        name

          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

          Required: Yes

        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? client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=authorization_code * 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.

        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? client_id=client_id&scope=data_source_scopes &redirect_uri=urn:ietf:wg:oauth:2.0:oob&response_type=version_info * 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

          Type: string

      Description: Updates a data transfer configuration. All fields must be set, even if they are not updated.

  • bigquerydatatransfer.projects.transferConfigs.list

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • https://www.googleapis.com/auth/cloud-platform.read-only
    • Description: Returns information about all transfer configs owned by a project in the specified location.

      Path: v1/{+parent}/transferConfigs

      Parameters:

        pageSize

          Description: Page size. The default page size is the maximum value of 1000 results.

          Format: int32

          Location: query

          Type: integer

        parent

          Type: string

          Pattern: ^projects/[^/]+$

          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

          Location: path

        dataSourceIds

          Type: string

          Description: When specified, only configurations of requested data sources are returned.

          Location: query

          Repeated: Yes

        pageToken

          Type: string

          Location: query

          Description: Pagination token, which can be used to request a specific page of `ListTransfersRequest` list results. For multiple-page results, `ListTransfersResponse` outputs a `next_page` token, which can be used as the `page_token` value to request the next page of list results.

      Parameter Order: parent

      HTTP Method: GET

      Flat Path: v1/projects/{projectsId}/transferConfigs

  • bigquerydatatransfer.projects.enrollDataSources

      Parameters:

        name

          Description: The name of the project resource in the form: `projects/{project_id}`

          Pattern: ^projects/[^/]+$

          Type: string

          Location: path

          Required: Yes

      HTTP Method: POST

      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

      Scopes:

    • https://www.googleapis.com/auth/bigquery
    • https://www.googleapis.com/auth/cloud-platform
    • Flat Path: v1/projects/{projectsId}:enrollDataSources

      Parameter Order: name