| Index: discovery/googleapis/bigquerydatatransfer__v1.json
|
| diff --git a/discovery/googleapis/bigquerydatatransfer__v1.json b/discovery/googleapis/bigquerydatatransfer__v1.json
|
| index d7c0381740ccc136202d53f5a122f6797ea4c8cc..1e5d9fa14d596117cfb45d89f601c97acdaf1a12 100644
|
| --- a/discovery/googleapis/bigquerydatatransfer__v1.json
|
| +++ b/discovery/googleapis/bigquerydatatransfer__v1.json
|
| @@ -4,6 +4,12 @@
|
| "scopes": {
|
| "https://www.googleapis.com/auth/bigquery": {
|
| "description": "View and manage your data in Google BigQuery"
|
| + },
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only": {
|
| + "description": "View your data across Google Cloud Platform services"
|
| + },
|
| + "https://www.googleapis.com/auth/cloud-platform": {
|
| + "description": "View and manage your data across Google Cloud Platform services"
|
| }
|
| }
|
| }
|
| @@ -25,6 +31,37 @@
|
| "ownerDomain": "google.com",
|
| "ownerName": "Google",
|
| "parameters": {
|
| + "key": {
|
| + "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "access_token": {
|
| + "description": "OAuth access token.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "quotaUser": {
|
| + "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "pp": {
|
| + "default": "true",
|
| + "description": "Pretty-print response.",
|
| + "location": "query",
|
| + "type": "boolean"
|
| + },
|
| + "oauth_token": {
|
| + "description": "OAuth 2.0 token for the current user.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "bearer_token": {
|
| + "description": "OAuth bearer token.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| "upload_protocol": {
|
| "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
|
| "location": "query",
|
| @@ -79,47 +116,16 @@
|
| ],
|
| "location": "query",
|
| "type": "string"
|
| - },
|
| - "key": {
|
| - "description": "API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "access_token": {
|
| - "description": "OAuth access token.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "quotaUser": {
|
| - "description": "Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "pp": {
|
| - "default": "true",
|
| - "description": "Pretty-print response.",
|
| - "location": "query",
|
| - "type": "boolean"
|
| - },
|
| - "oauth_token": {
|
| - "description": "OAuth 2.0 token for the current user.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "bearer_token": {
|
| - "description": "OAuth bearer token.",
|
| - "location": "query",
|
| - "type": "string"
|
| }
|
| },
|
| "protocol": "rest",
|
| "resources": {
|
| "projects": {
|
| "methods": {
|
| - "isEnabled": {
|
| - "description": "Returns true if data transfer is enabled for a project.",
|
| + "setEnabled": {
|
| + "description": "Enables or disables data transfer for a project. This\nmethod requires the additional scope of\n'https://www.googleapis.com/auth/cloudplatformprojects'\nto manage the cloud project permissions.",
|
| "httpMethod": "POST",
|
| - "id": "bigquerydatatransfer.projects.isEnabled",
|
| + "id": "bigquerydatatransfer.projects.setEnabled",
|
| "parameterOrder": [
|
| "name"
|
| ],
|
| @@ -132,21 +138,21 @@
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/{+name}:isEnabled",
|
| + "path": "v1/{+name}:setEnabled",
|
| "request": {
|
| - "$ref": "IsEnabledRequest"
|
| + "$ref": "SetEnabledRequest"
|
| },
|
| "response": {
|
| - "$ref": "IsEnabledResponse"
|
| + "$ref": "Empty"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| + "https://www.googleapis.com/auth/cloud-platform"
|
| ]
|
| },
|
| - "setEnabled": {
|
| - "description": "Enables or disables data transfer for a project. This\nmethod requires the additional scope of\n'https://www.googleapis.com/auth/cloudplatformprojects'\nto manage the cloud project permissions.",
|
| + "isEnabled": {
|
| + "description": "Returns true if data transfer is enabled for a project.",
|
| "httpMethod": "POST",
|
| - "id": "bigquerydatatransfer.projects.setEnabled",
|
| + "id": "bigquerydatatransfer.projects.isEnabled",
|
| "parameterOrder": [
|
| "name"
|
| ],
|
| @@ -159,13 +165,18 @@
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/{+name}:setEnabled",
|
| + "path": "v1/{+name}:isEnabled",
|
| "request": {
|
| - "$ref": "SetEnabledRequest"
|
| + "$ref": "IsEnabledRequest"
|
| },
|
| "response": {
|
| - "$ref": "Empty"
|
| - }
|
| + "$ref": "IsEnabledResponse"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only"
|
| + ]
|
| }
|
| },
|
| "resources": {
|
| @@ -195,7 +206,9 @@
|
| "$ref": "IsEnabledResponse"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only"
|
| ]
|
| },
|
| "setEnabled": {
|
| @@ -220,80 +233,128 @@
|
| },
|
| "response": {
|
| "$ref": "Empty"
|
| - }
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/cloud-platform"
|
| + ]
|
| }
|
| },
|
| "resources": {
|
| - "dataSources": {
|
| + "transferConfigs": {
|
| "methods": {
|
| - "checkValidCreds": {
|
| - "description": "Returns true if valid credentials exist for the given data source and\nrequesting user.",
|
| - "httpMethod": "POST",
|
| - "id": "bigquerydatatransfer.projects.locations.dataSources.checkValidCreds",
|
| + "get": {
|
| + "description": "Returns information about a data transfer config.",
|
| + "httpMethod": "GET",
|
| + "id": "bigquerydatatransfer.projects.locations.transferConfigs.get",
|
| "parameterOrder": [
|
| "name"
|
| ],
|
| "parameters": {
|
| "name": {
|
| - "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`",
|
| + "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
|
| "location": "path",
|
| - "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$",
|
| + "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| - "path": "v1/{+name}:checkValidCreds",
|
| + "path": "v1/{+name}",
|
| + "response": {
|
| + "$ref": "TransferConfig"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only"
|
| + ]
|
| + },
|
| + "patch": {
|
| + "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.",
|
| + "httpMethod": "PATCH",
|
| + "id": "bigquerydatatransfer.projects.locations.transferConfigs.patch",
|
| + "parameterOrder": [
|
| + "name"
|
| + ],
|
| + "parameters": {
|
| + "authorizationCode": {
|
| + "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\ngaia id of the authorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "updateMask": {
|
| + "description": "Required list of fields to be updated in this request.",
|
| + "format": "google-fieldmask",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "name": {
|
| + "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer run.",
|
| + "location": "path",
|
| + "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/{+name}",
|
| "request": {
|
| - "$ref": "CheckValidCredsRequest"
|
| + "$ref": "TransferConfig"
|
| },
|
| "response": {
|
| - "$ref": "CheckValidCredsResponse"
|
| + "$ref": "TransferConfig"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform"
|
| ]
|
| },
|
| - "get": {
|
| - "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering.",
|
| - "httpMethod": "GET",
|
| - "id": "bigquerydatatransfer.projects.locations.dataSources.get",
|
| + "delete": {
|
| + "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs.",
|
| + "httpMethod": "DELETE",
|
| + "id": "bigquerydatatransfer.projects.locations.transferConfigs.delete",
|
| "parameterOrder": [
|
| "name"
|
| ],
|
| "parameters": {
|
| "name": {
|
| - "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`",
|
| + "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
|
| "location": "path",
|
| - "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$",
|
| + "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| }
|
| },
|
| "path": "v1/{+name}",
|
| "response": {
|
| - "$ref": "DataSource"
|
| + "$ref": "Empty"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform"
|
| ]
|
| },
|
| "list": {
|
| - "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
|
| + "description": "Returns information about all data transfers in the project.",
|
| "httpMethod": "GET",
|
| - "id": "bigquerydatatransfer.projects.locations.dataSources.list",
|
| + "id": "bigquerydatatransfer.projects.locations.transferConfigs.list",
|
| "parameterOrder": [
|
| "parent"
|
| ],
|
| "parameters": {
|
| + "dataSourceIds": {
|
| + "description": "When specified, only configurations of requested data sources are returned.",
|
| + "location": "query",
|
| + "repeated": true,
|
| + "type": "string"
|
| + },
|
| "parent": {
|
| - "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
|
| + "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
|
| "location": "path",
|
| "pattern": "^projects/[^/]+/locations/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| },
|
| "pageToken": {
|
| - "description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
|
| + "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
|
| "location": "query",
|
| "type": "string"
|
| },
|
| @@ -304,18 +365,16 @@
|
| "type": "integer"
|
| }
|
| },
|
| - "path": "v1/{+parent}/dataSources",
|
| + "path": "v1/{+parent}/transferConfigs",
|
| "response": {
|
| - "$ref": "ListDataSourcesResponse"
|
| + "$ref": "ListTransferConfigsResponse"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only"
|
| ]
|
| - }
|
| - }
|
| - },
|
| - "transferConfigs": {
|
| - "methods": {
|
| + },
|
| "create": {
|
| "description": "Creates a new data transfer configuration.",
|
| "httpMethod": "POST",
|
| @@ -330,7 +389,7 @@
|
| "type": "string"
|
| },
|
| "parent": {
|
| - "description": "The BigQuery project id where the transfer configuration should be created.",
|
| + "description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format /projects/{project_id}/locations/{location_id}\nor\n/projects/{project_id}/locations/-\nIn case when '-' is specified as location_id, location is infered from\nthe destination dataset region.",
|
| "location": "path",
|
| "pattern": "^projects/[^/]+/locations/[^/]+$",
|
| "required": true,
|
| @@ -345,7 +404,8 @@
|
| "$ref": "TransferConfig"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform"
|
| ]
|
| },
|
| "scheduleRuns": {
|
| @@ -372,187 +432,38 @@
|
| "$ref": "ScheduleTransferRunsResponse"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform"
|
| ]
|
| - },
|
| - "patch": {
|
| - "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.",
|
| - "httpMethod": "PATCH",
|
| - "id": "bigquerydatatransfer.projects.locations.transferConfigs.patch",
|
| - "parameterOrder": [
|
| - "name"
|
| - ],
|
| - "parameters": {
|
| - "authorizationCode": {
|
| - "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\ngaia id of the authorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "updateMask": {
|
| - "description": "Required list of fields to be updated in this request.",
|
| - "format": "google-fieldmask",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "name": {
|
| - "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer run.",
|
| - "location": "path",
|
| - "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/{+name}",
|
| - "request": {
|
| - "$ref": "TransferConfig"
|
| - },
|
| - "response": {
|
| - "$ref": "TransferConfig"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| - ]
|
| - },
|
| - "get": {
|
| - "description": "Returns information about a data transfer config.",
|
| - "httpMethod": "GET",
|
| - "id": "bigquerydatatransfer.projects.locations.transferConfigs.get",
|
| - "parameterOrder": [
|
| - "name"
|
| - ],
|
| - "parameters": {
|
| - "name": {
|
| - "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
|
| - "location": "path",
|
| - "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/{+name}",
|
| - "response": {
|
| - "$ref": "TransferConfig"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| - ]
|
| - },
|
| - "delete": {
|
| - "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs.",
|
| - "httpMethod": "DELETE",
|
| - "id": "bigquerydatatransfer.projects.locations.transferConfigs.delete",
|
| - "parameterOrder": [
|
| - "name"
|
| - ],
|
| - "parameters": {
|
| - "name": {
|
| - "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
|
| - "location": "path",
|
| - "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/{+name}",
|
| - "response": {
|
| - "$ref": "Empty"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| - ]
|
| - },
|
| - "list": {
|
| - "description": "Returns information about all data transfers in the project.",
|
| - "httpMethod": "GET",
|
| - "id": "bigquerydatatransfer.projects.locations.transferConfigs.list",
|
| - "parameterOrder": [
|
| - "parent"
|
| - ],
|
| - "parameters": {
|
| - "pageToken": {
|
| - "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "pageSize": {
|
| - "description": "Page size. The default page size is the maximum value of 1000 results.",
|
| - "format": "int32",
|
| - "location": "query",
|
| - "type": "integer"
|
| - },
|
| - "parent": {
|
| - "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
|
| - "location": "path",
|
| - "pattern": "^projects/[^/]+/locations/[^/]+$",
|
| - "required": true,
|
| - "type": "string"
|
| - },
|
| - "dataSourceIds": {
|
| - "description": "When specified, only configurations of requested data sources are returned.",
|
| - "location": "query",
|
| - "repeated": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/{+parent}/transferConfigs",
|
| - "response": {
|
| - "$ref": "ListTransferConfigsResponse"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| - ]
|
| - }
|
| - },
|
| - "resources": {
|
| - "runs": {
|
| - "methods": {
|
| - "delete": {
|
| - "description": "Deletes the specified transfer run.",
|
| - "httpMethod": "DELETE",
|
| - "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.delete",
|
| - "parameterOrder": [
|
| - "name"
|
| - ],
|
| - "parameters": {
|
| - "name": {
|
| - "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
|
| - "location": "path",
|
| - "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/{+name}",
|
| - "response": {
|
| - "$ref": "Empty"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| - ]
|
| - },
|
| - "get": {
|
| - "description": "Returns information about the particular transfer run.",
|
| - "httpMethod": "GET",
|
| - "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.get",
|
| - "parameterOrder": [
|
| - "name"
|
| - ],
|
| - "parameters": {
|
| - "name": {
|
| - "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
|
| - "location": "path",
|
| - "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/{+name}",
|
| - "response": {
|
| - "$ref": "TransferRun"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| - ]
|
| + }
|
| + },
|
| + "resources": {
|
| + "runs": {
|
| + "methods": {
|
| + "delete": {
|
| + "description": "Deletes the specified transfer run.",
|
| + "httpMethod": "DELETE",
|
| + "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.delete",
|
| + "parameterOrder": [
|
| + "name"
|
| + ],
|
| + "parameters": {
|
| + "name": {
|
| + "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
|
| + "location": "path",
|
| + "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/{+name}",
|
| + "response": {
|
| + "$ref": "Empty"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform"
|
| + ]
|
| },
|
| "list": {
|
| "description": "Returns information about running and completed jobs.",
|
| @@ -567,6 +478,12 @@
|
| "location": "query",
|
| "type": "string"
|
| },
|
| + "pageSize": {
|
| + "description": "Page size. The default page size is the maximum value of 1000 results.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| "statuses": {
|
| "description": "When specified, only transfer runs with requested statuses are returned.",
|
| "enum": [
|
| @@ -582,12 +499,6 @@
|
| "repeated": true,
|
| "type": "string"
|
| },
|
| - "pageSize": {
|
| - "description": "Page size. The default page size is the maximum value of 1000 results.",
|
| - "format": "int32",
|
| - "location": "query",
|
| - "type": "integer"
|
| - },
|
| "runAttempt": {
|
| "description": "Indicates how run attempts are to be pulled.",
|
| "enum": [
|
| @@ -610,7 +521,35 @@
|
| "$ref": "ListTransferRunsResponse"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only"
|
| + ]
|
| + },
|
| + "get": {
|
| + "description": "Returns information about the particular transfer run.",
|
| + "httpMethod": "GET",
|
| + "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.get",
|
| + "parameterOrder": [
|
| + "name"
|
| + ],
|
| + "parameters": {
|
| + "name": {
|
| + "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
|
| + "location": "path",
|
| + "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/{+name}",
|
| + "response": {
|
| + "$ref": "TransferRun"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only"
|
| ]
|
| }
|
| },
|
| @@ -625,17 +564,6 @@
|
| "parent"
|
| ],
|
| "parameters": {
|
| - "pageToken": {
|
| - "description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "pageSize": {
|
| - "description": "Page size. The default page size is the maximum value of 1000 results.",
|
| - "format": "int32",
|
| - "location": "query",
|
| - "type": "integer"
|
| - },
|
| "messageTypes": {
|
| "description": "Message types to return. If not populated - INFO, WARNING and ERROR\nmessages are returned.",
|
| "enum": [
|
| @@ -654,6 +582,17 @@
|
| "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| + },
|
| + "pageToken": {
|
| + "description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "pageSize": {
|
| + "description": "Page size. The default page size is the maximum value of 1000 results.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| }
|
| },
|
| "path": "v1/{+parent}/transferLogs",
|
| @@ -661,7 +600,9 @@
|
| "$ref": "ListTransferLogsResponse"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only"
|
| ]
|
| }
|
| }
|
| @@ -669,96 +610,102 @@
|
| }
|
| }
|
| }
|
| - }
|
| - }
|
| - },
|
| - "dataSources": {
|
| - "methods": {
|
| - "checkValidCreds": {
|
| - "description": "Returns true if valid credentials exist for the given data source and\nrequesting user.",
|
| - "httpMethod": "POST",
|
| - "id": "bigquerydatatransfer.projects.dataSources.checkValidCreds",
|
| - "parameterOrder": [
|
| - "name"
|
| - ],
|
| - "parameters": {
|
| - "name": {
|
| - "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`",
|
| - "location": "path",
|
| - "pattern": "^projects/[^/]+/dataSources/[^/]+$",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/{+name}:checkValidCreds",
|
| - "request": {
|
| - "$ref": "CheckValidCredsRequest"
|
| - },
|
| - "response": {
|
| - "$ref": "CheckValidCredsResponse"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| - ]
|
| - },
|
| - "get": {
|
| - "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering.",
|
| - "httpMethod": "GET",
|
| - "id": "bigquerydatatransfer.projects.dataSources.get",
|
| - "parameterOrder": [
|
| - "name"
|
| - ],
|
| - "parameters": {
|
| - "name": {
|
| - "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`",
|
| - "location": "path",
|
| - "pattern": "^projects/[^/]+/dataSources/[^/]+$",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/{+name}",
|
| - "response": {
|
| - "$ref": "DataSource"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| - ]
|
| },
|
| - "list": {
|
| - "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
|
| - "httpMethod": "GET",
|
| - "id": "bigquerydatatransfer.projects.dataSources.list",
|
| - "parameterOrder": [
|
| - "parent"
|
| - ],
|
| - "parameters": {
|
| - "pageToken": {
|
| - "description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "pageSize": {
|
| - "description": "Page size. The default page size is the maximum value of 1000 results.",
|
| - "format": "int32",
|
| - "location": "query",
|
| - "type": "integer"
|
| + "dataSources": {
|
| + "methods": {
|
| + "list": {
|
| + "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
|
| + "httpMethod": "GET",
|
| + "id": "bigquerydatatransfer.projects.locations.dataSources.list",
|
| + "parameterOrder": [
|
| + "parent"
|
| + ],
|
| + "parameters": {
|
| + "pageToken": {
|
| + "description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "pageSize": {
|
| + "description": "Page size. The default page size is the maximum value of 1000 results.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| + "parent": {
|
| + "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
|
| + "location": "path",
|
| + "pattern": "^projects/[^/]+/locations/[^/]+$",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/{+parent}/dataSources",
|
| + "response": {
|
| + "$ref": "ListDataSourcesResponse"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only"
|
| + ]
|
| },
|
| - "parent": {
|
| - "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
|
| - "location": "path",
|
| - "pattern": "^projects/[^/]+$",
|
| - "required": true,
|
| - "type": "string"
|
| + "get": {
|
| + "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering.",
|
| + "httpMethod": "GET",
|
| + "id": "bigquerydatatransfer.projects.locations.dataSources.get",
|
| + "parameterOrder": [
|
| + "name"
|
| + ],
|
| + "parameters": {
|
| + "name": {
|
| + "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`",
|
| + "location": "path",
|
| + "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/{+name}",
|
| + "response": {
|
| + "$ref": "DataSource"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only"
|
| + ]
|
| + },
|
| + "checkValidCreds": {
|
| + "description": "Returns true if valid credentials exist for the given data source and\nrequesting user.",
|
| + "httpMethod": "POST",
|
| + "id": "bigquerydatatransfer.projects.locations.dataSources.checkValidCreds",
|
| + "parameterOrder": [
|
| + "name"
|
| + ],
|
| + "parameters": {
|
| + "name": {
|
| + "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`",
|
| + "location": "path",
|
| + "pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/{+name}:checkValidCreds",
|
| + "request": {
|
| + "$ref": "CheckValidCredsRequest"
|
| + },
|
| + "response": {
|
| + "$ref": "CheckValidCredsResponse"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only"
|
| + ]
|
| }
|
| - },
|
| - "path": "v1/{+parent}/dataSources",
|
| - "response": {
|
| - "$ref": "ListDataSourcesResponse"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| - ]
|
| + }
|
| }
|
| }
|
| },
|
| @@ -785,7 +732,8 @@
|
| "$ref": "Empty"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform"
|
| ]
|
| },
|
| "list": {
|
| @@ -796,17 +744,12 @@
|
| "parent"
|
| ],
|
| "parameters": {
|
| - "pageToken": {
|
| - "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`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",
|
| + "repeated": true,
|
| "type": "string"
|
| },
|
| - "pageSize": {
|
| - "description": "Page size. The default page size is the maximum value of 1000 results.",
|
| - "format": "int32",
|
| - "location": "query",
|
| - "type": "integer"
|
| - },
|
| "parent": {
|
| "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
|
| "location": "path",
|
| @@ -814,11 +757,16 @@
|
| "required": true,
|
| "type": "string"
|
| },
|
| - "dataSourceIds": {
|
| - "description": "When specified, only configurations of requested data sources are returned.",
|
| + "pageToken": {
|
| + "description": "Pagination token, which can be used to request a specific page\nof `ListTransfersRequest` list results. For multiple-page\nresults, `ListTransfersResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
|
| "location": "query",
|
| - "repeated": true,
|
| "type": "string"
|
| + },
|
| + "pageSize": {
|
| + "description": "Page size. The default page size is the maximum value of 1000 results.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| }
|
| },
|
| "path": "v1/{+parent}/transferConfigs",
|
| @@ -826,7 +774,9 @@
|
| "$ref": "ListTransferConfigsResponse"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only"
|
| ]
|
| },
|
| "create": {
|
| @@ -837,17 +787,17 @@
|
| "parent"
|
| ],
|
| "parameters": {
|
| + "authorizationCode": {
|
| + "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nThis is required if new credentials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| "parent": {
|
| - "description": "The BigQuery project id where the transfer configuration should be created.",
|
| + "description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format /projects/{project_id}/locations/{location_id}\nor\n/projects/{project_id}/locations/-\nIn case when '-' is specified as location_id, location is infered from\nthe destination dataset region.",
|
| "location": "path",
|
| "pattern": "^projects/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| - },
|
| - "authorizationCode": {
|
| - "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nThis is required if new credentials are needed, as indicated by\n`CheckValidCreds`.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
|
| - "location": "query",
|
| - "type": "string"
|
| }
|
| },
|
| "path": "v1/{+parent}/transferConfigs",
|
| @@ -858,7 +808,8 @@
|
| "$ref": "TransferConfig"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform"
|
| ]
|
| },
|
| "scheduleRuns": {
|
| @@ -885,69 +836,73 @@
|
| "$ref": "ScheduleTransferRunsResponse"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform"
|
| ]
|
| },
|
| - "get": {
|
| - "description": "Returns information about a data transfer config.",
|
| - "httpMethod": "GET",
|
| - "id": "bigquerydatatransfer.projects.transferConfigs.get",
|
| + "patch": {
|
| + "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.",
|
| + "httpMethod": "PATCH",
|
| + "id": "bigquerydatatransfer.projects.transferConfigs.patch",
|
| "parameterOrder": [
|
| "name"
|
| ],
|
| "parameters": {
|
| "name": {
|
| - "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
|
| + "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer run.",
|
| "location": "path",
|
| "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| + },
|
| + "authorizationCode": {
|
| + "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\ngaia id of the authorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "updateMask": {
|
| + "description": "Required list of fields to be updated in this request.",
|
| + "format": "google-fieldmask",
|
| + "location": "query",
|
| + "type": "string"
|
| }
|
| },
|
| "path": "v1/{+name}",
|
| + "request": {
|
| + "$ref": "TransferConfig"
|
| + },
|
| "response": {
|
| "$ref": "TransferConfig"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform"
|
| ]
|
| },
|
| - "patch": {
|
| - "description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.",
|
| - "httpMethod": "PATCH",
|
| - "id": "bigquerydatatransfer.projects.transferConfigs.patch",
|
| + "get": {
|
| + "description": "Returns information about a data transfer config.",
|
| + "httpMethod": "GET",
|
| + "id": "bigquerydatatransfer.projects.transferConfigs.get",
|
| "parameterOrder": [
|
| "name"
|
| ],
|
| "parameters": {
|
| - "updateMask": {
|
| - "description": "Required list of fields to be updated in this request.",
|
| - "format": "google-fieldmask",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| "name": {
|
| - "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/transferConfigs/{config_id}`.\nWhere `config_id` is usually a uuid, even though it is not\nguaranteed or required. The name is ignored when creating a transfer run.",
|
| + "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
|
| "location": "path",
|
| "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
|
| "required": true,
|
| "type": "string"
|
| - },
|
| - "authorizationCode": {
|
| - "description": "Optional OAuth2 authorization code to use with this transfer configuration.\nIf it is provided, the transfer configuration will be associated with the\ngaia id of the authorizing user.\nIn order to obtain authorization_code, please make a\nrequest to\nhttps://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>\n\n* client_id should be OAuth client_id of BigQuery DTS API for the given\n data source returned by ListDataSources method.\n* data_source_scopes are the scopes returned by ListDataSources method.\n* redirect_uri is an optional parameter. If not specified, then\n authorization code is posted to the opener of authorization flow window.\n Otherwise it will be sent to the redirect uri. A special value of\n urn:ietf:wg:oauth:2.0:oob means that authorization code should be\n returned in the title bar of the browser, with the page text prompting\n the user to copy the code and paste it in the application.",
|
| - "location": "query",
|
| - "type": "string"
|
| }
|
| },
|
| "path": "v1/{+name}",
|
| - "request": {
|
| - "$ref": "TransferConfig"
|
| - },
|
| "response": {
|
| "$ref": "TransferConfig"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only"
|
| ]
|
| }
|
| },
|
| @@ -975,31 +930,8 @@
|
| "$ref": "Empty"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| - ]
|
| - },
|
| - "get": {
|
| - "description": "Returns information about the particular transfer run.",
|
| - "httpMethod": "GET",
|
| - "id": "bigquerydatatransfer.projects.transferConfigs.runs.get",
|
| - "parameterOrder": [
|
| - "name"
|
| - ],
|
| - "parameters": {
|
| - "name": {
|
| - "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
|
| - "location": "path",
|
| - "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
|
| - "required": true,
|
| - "type": "string"
|
| - }
|
| - },
|
| - "path": "v1/{+name}",
|
| - "response": {
|
| - "$ref": "TransferRun"
|
| - },
|
| - "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform"
|
| ]
|
| },
|
| "list": {
|
| @@ -1010,6 +942,15 @@
|
| "parent"
|
| ],
|
| "parameters": {
|
| + "runAttempt": {
|
| + "description": "Indicates how run attempts are to be pulled.",
|
| + "enum": [
|
| + "RUN_ATTEMPT_UNSPECIFIED",
|
| + "LATEST"
|
| + ],
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| "parent": {
|
| "description": "Name of transfer configuration for which transfer runs should be retrieved.\nFormat of transfer configuration resource name is:\n`projects/{project_id}/transferConfigs/{config_id}`.",
|
| "location": "path",
|
| @@ -1022,6 +963,12 @@
|
| "location": "query",
|
| "type": "string"
|
| },
|
| + "pageSize": {
|
| + "description": "Page size. The default page size is the maximum value of 1000 results.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| "statuses": {
|
| "description": "When specified, only transfer runs with requested statuses are returned.",
|
| "enum": [
|
| @@ -1036,21 +983,6 @@
|
| "location": "query",
|
| "repeated": true,
|
| "type": "string"
|
| - },
|
| - "pageSize": {
|
| - "description": "Page size. The default page size is the maximum value of 1000 results.",
|
| - "format": "int32",
|
| - "location": "query",
|
| - "type": "integer"
|
| - },
|
| - "runAttempt": {
|
| - "description": "Indicates how run attempts are to be pulled.",
|
| - "enum": [
|
| - "RUN_ATTEMPT_UNSPECIFIED",
|
| - "LATEST"
|
| - ],
|
| - "location": "query",
|
| - "type": "string"
|
| }
|
| },
|
| "path": "v1/{+parent}/runs",
|
| @@ -1058,30 +990,58 @@
|
| "$ref": "ListTransferRunsResponse"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only"
|
| ]
|
| - }
|
| - },
|
| - "resources": {
|
| - "transferLogs": {
|
| - "methods": {
|
| - "list": {
|
| - "description": "Returns user facing log messages for the data transfer run.",
|
| - "httpMethod": "GET",
|
| - "id": "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list",
|
| - "parameterOrder": [
|
| - "parent"
|
| - ],
|
| - "parameters": {
|
| - "pageToken": {
|
| - "description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
|
| - "location": "query",
|
| - "type": "string"
|
| - },
|
| - "pageSize": {
|
| - "description": "Page size. The default page size is the maximum value of 1000 results.",
|
| - "format": "int32",
|
| - "location": "query",
|
| + },
|
| + "get": {
|
| + "description": "Returns information about the particular transfer run.",
|
| + "httpMethod": "GET",
|
| + "id": "bigquerydatatransfer.projects.transferConfigs.runs.get",
|
| + "parameterOrder": [
|
| + "name"
|
| + ],
|
| + "parameters": {
|
| + "name": {
|
| + "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
|
| + "location": "path",
|
| + "pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/{+name}",
|
| + "response": {
|
| + "$ref": "TransferRun"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only"
|
| + ]
|
| + }
|
| + },
|
| + "resources": {
|
| + "transferLogs": {
|
| + "methods": {
|
| + "list": {
|
| + "description": "Returns user facing log messages for the data transfer run.",
|
| + "httpMethod": "GET",
|
| + "id": "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list",
|
| + "parameterOrder": [
|
| + "parent"
|
| + ],
|
| + "parameters": {
|
| + "pageToken": {
|
| + "description": "Pagination token, which can be used to request a specific page\nof `ListTransferLogsRequest` list results. For multiple-page\nresults, `ListTransferLogsResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "pageSize": {
|
| + "description": "Page size. The default page size is the maximum value of 1000 results.",
|
| + "format": "int32",
|
| + "location": "query",
|
| "type": "integer"
|
| },
|
| "messageTypes": {
|
| @@ -1109,7 +1069,9 @@
|
| "$ref": "ListTransferLogsResponse"
|
| },
|
| "scopes": [
|
| - "https://www.googleapis.com/auth/bigquery"
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only"
|
| ]
|
| }
|
| }
|
| @@ -1117,344 +1079,190 @@
|
| }
|
| }
|
| }
|
| + },
|
| + "dataSources": {
|
| + "methods": {
|
| + "list": {
|
| + "description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
|
| + "httpMethod": "GET",
|
| + "id": "bigquerydatatransfer.projects.dataSources.list",
|
| + "parameterOrder": [
|
| + "parent"
|
| + ],
|
| + "parameters": {
|
| + "pageToken": {
|
| + "description": "Pagination token, which can be used to request a specific page\nof `ListDataSourcesRequest` list results. For multiple-page\nresults, `ListDataSourcesResponse` outputs\na `next_page` token, which can be used as the\n`page_token` value to request the next page of list results.",
|
| + "location": "query",
|
| + "type": "string"
|
| + },
|
| + "pageSize": {
|
| + "description": "Page size. The default page size is the maximum value of 1000 results.",
|
| + "format": "int32",
|
| + "location": "query",
|
| + "type": "integer"
|
| + },
|
| + "parent": {
|
| + "description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
|
| + "location": "path",
|
| + "pattern": "^projects/[^/]+$",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/{+parent}/dataSources",
|
| + "response": {
|
| + "$ref": "ListDataSourcesResponse"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only"
|
| + ]
|
| + },
|
| + "get": {
|
| + "description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering.",
|
| + "httpMethod": "GET",
|
| + "id": "bigquerydatatransfer.projects.dataSources.get",
|
| + "parameterOrder": [
|
| + "name"
|
| + ],
|
| + "parameters": {
|
| + "name": {
|
| + "description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`",
|
| + "location": "path",
|
| + "pattern": "^projects/[^/]+/dataSources/[^/]+$",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/{+name}",
|
| + "response": {
|
| + "$ref": "DataSource"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only"
|
| + ]
|
| + },
|
| + "checkValidCreds": {
|
| + "description": "Returns true if valid credentials exist for the given data source and\nrequesting user.",
|
| + "httpMethod": "POST",
|
| + "id": "bigquerydatatransfer.projects.dataSources.checkValidCreds",
|
| + "parameterOrder": [
|
| + "name"
|
| + ],
|
| + "parameters": {
|
| + "name": {
|
| + "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`",
|
| + "location": "path",
|
| + "pattern": "^projects/[^/]+/dataSources/[^/]+$",
|
| + "required": true,
|
| + "type": "string"
|
| + }
|
| + },
|
| + "path": "v1/{+name}:checkValidCreds",
|
| + "request": {
|
| + "$ref": "CheckValidCredsRequest"
|
| + },
|
| + "response": {
|
| + "$ref": "CheckValidCredsResponse"
|
| + },
|
| + "scopes": [
|
| + "https://www.googleapis.com/auth/bigquery",
|
| + "https://www.googleapis.com/auth/cloud-platform",
|
| + "https://www.googleapis.com/auth/cloud-platform.read-only"
|
| + ]
|
| + }
|
| + }
|
| }
|
| }
|
| }
|
| },
|
| - "revision": "20170609",
|
| + "revision": "20170703",
|
| "rootUrl": "https://bigquerydatatransfer.googleapis.com/",
|
| "schemas": {
|
| - "CheckValidCredsResponse": {
|
| - "description": "A response indicating whether the credentials exist and are valid.",
|
| - "id": "CheckValidCredsResponse",
|
| - "properties": {
|
| - "hasValidCreds": {
|
| - "description": "If set to `true`, the credentials exist and are valid.",
|
| - "type": "boolean"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ScheduleTransferRunsResponse": {
|
| - "description": "A response to schedule transfer runs for a time range.",
|
| - "id": "ScheduleTransferRunsResponse",
|
| - "properties": {
|
| - "createdRuns": {
|
| - "description": "The transfer runs that were created.",
|
| - "items": {
|
| - "$ref": "TransferRun"
|
| - },
|
| - "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ListTransferLogsResponse": {
|
| - "description": "The returned list transfer run messages.",
|
| - "id": "ListTransferLogsResponse",
|
| + "DataSource": {
|
| + "description": "Represents data source metadata. Metadata is sufficient to\nrender UI and request proper OAuth tokens.",
|
| + "id": "DataSource",
|
| "properties": {
|
| - "transferMessages": {
|
| - "description": "The stored pipeline transfer messages.\n@OutputOnly",
|
| + "name": {
|
| + "description": "Data source resource name.",
|
| + "type": "string"
|
| + },
|
| + "scopes": {
|
| + "description": "Api auth scopes for which refresh token needs to be obtained. Only valid\nwhen `client_id` is specified. Ignored otherwise. These are scopes needed\nby a data source to prepare data and ingest them into BigQuery,\ne.g., https://www.googleapis.com/auth/bigquery",
|
| "items": {
|
| - "$ref": "TransferMessage"
|
| + "type": "string"
|
| },
|
| "type": "array"
|
| },
|
| - "nextPageToken": {
|
| - "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`GetTransferRunLogRequest.page_token`\nto request the next page of list results.\n@OutputOnly",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "TransferMessage": {
|
| - "description": "Represents a user facing message for a particular data transfer run.",
|
| - "id": "TransferMessage",
|
| - "properties": {
|
| - "messageTime": {
|
| - "description": "Time when message was logged.",
|
| - "format": "google-datetime",
|
| + "clientId": {
|
| + "description": "Data source client id which should be used to receive refresh token.\nWhen not supplied, no offline credentials are populated for data transfer.",
|
| "type": "string"
|
| },
|
| - "severity": {
|
| - "description": "Message severity.",
|
| + "authorizationType": {
|
| + "description": "Indicates the type of authorization.",
|
| "enum": [
|
| - "MESSAGE_SEVERITY_UNSPECIFIED",
|
| - "INFO",
|
| - "WARNING",
|
| - "ERROR"
|
| + "AUTHORIZATION_TYPE_UNSPECIFIED",
|
| + "AUTHORIZATION_CODE",
|
| + "GOOGLE_PLUS_AUTHORIZATION_CODE"
|
| ],
|
| "enumDescriptions": [
|
| - "No severity specified.",
|
| - "Informational message.",
|
| - "Warning message.",
|
| - "Error message."
|
| + "Type unspecified.",
|
| + "Use OAuth 2 authorization codes that can be exchanged\nfor a refresh token on the backend.",
|
| + "Return an authorization code for a given Google+ page that can then be\nexchanged for a refresh token on the backend."
|
| ],
|
| "type": "string"
|
| },
|
| - "messageText": {
|
| - "description": "Message text.",
|
| + "supportsCustomSchedule": {
|
| + "description": "Specifies whether the data source supports a user defined schedule, or\noperates on the default schedule.\nWhen set to `true`, user can override default schedule.",
|
| + "type": "boolean"
|
| + },
|
| + "displayName": {
|
| + "description": "User friendly data source name.",
|
| "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ListDataSourcesResponse": {
|
| - "description": "Returns list of supported data sources and their metadata.",
|
| - "id": "ListDataSourcesResponse",
|
| - "properties": {
|
| - "dataSources": {
|
| - "description": "List of supported data sources and their transfer settings.",
|
| + },
|
| + "dataRefreshType": {
|
| + "description": "Specifies whether the data source supports automatic data refresh for the\npast few days, and how it's supported.\nFor some data sources, data might not be complete until a few days later,\nso it's useful to refresh data automatically.",
|
| + "enum": [
|
| + "NONE",
|
| + "SLIDING_WINDOW",
|
| + "CUSTOM_SLIDING_WINDOW"
|
| + ],
|
| + "enumDescriptions": [
|
| + "The data source won't support data auto refresh, which is default value.",
|
| + "The data source supports data auto refresh, and runs will be scheduled\nfor the past few days. Does not allow custom values to be set for each\ntransfer config.",
|
| + "The data source supports data auto refresh, and runs will be scheduled\nfor the past few days. Allows custom values to be set for each transfer\nconfig."
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "parameters": {
|
| + "description": "Data source parameters.",
|
| "items": {
|
| - "$ref": "DataSource"
|
| + "$ref": "DataSourceParameter"
|
| },
|
| "type": "array"
|
| },
|
| - "nextPageToken": {
|
| - "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListDataSourcesRequest.page_token`\nto request the next page of list results.\n@OutputOnly",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "DataSourceParameter": {
|
| - "description": "Represents a data source parameter with validation rules, so that\nparameters can be rendered in the UI. These parameters are given to us by\nsupported data sources, and include all needed information for rendering\nand validation.\nThus, whoever uses this api can decide to generate either generic ui,\nor custom data source specific forms.",
|
| - "id": "DataSourceParameter",
|
| - "properties": {
|
| - "validationHelpUrl": {
|
| - "description": "URL to a help document to further explain the naming requirements.",
|
| - "type": "string"
|
| - },
|
| - "minValue": {
|
| - "description": "For integer and double values specifies minimum allowed value.",
|
| - "format": "double",
|
| - "type": "number"
|
| - },
|
| - "validationRegex": {
|
| - "description": "Regular expression which can be used for parameter validation.",
|
| - "type": "string"
|
| - },
|
| - "paramId": {
|
| - "description": "Parameter identifier.",
|
| - "type": "string"
|
| - },
|
| - "required": {
|
| - "description": "Is parameter required.",
|
| - "type": "boolean"
|
| - },
|
| - "repeated": {
|
| - "description": "Can parameter have multiple values.",
|
| - "type": "boolean"
|
| - },
|
| - "displayName": {
|
| - "description": "Parameter display name in the user interface.",
|
| - "type": "string"
|
| - },
|
| - "validationDescription": {
|
| - "description": "Description of the requirements for this field, in case the user input does\nnot fulfill the regex pattern or min/max values.",
|
| - "type": "string"
|
| - },
|
| - "immutable": {
|
| - "description": "Cannot be changed after initial creation.",
|
| - "type": "boolean"
|
| - },
|
| - "fields": {
|
| - "description": "When parameter is a record, describes child fields.",
|
| - "items": {
|
| - "$ref": "DataSourceParameter"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "maxValue": {
|
| - "description": "For integer and double values specifies maxminum allowed value.",
|
| - "format": "double",
|
| - "type": "number"
|
| - },
|
| - "type": {
|
| - "description": "Parameter type.",
|
| - "enum": [
|
| - "TYPE_UNSPECIFIED",
|
| - "STRING",
|
| - "INTEGER",
|
| - "DOUBLE",
|
| - "BOOLEAN",
|
| - "RECORD",
|
| - "PLUS_PAGE"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Type unspecified.",
|
| - "String parameter.",
|
| - "Integer parameter (64-bits).\nWill be serialized to json as string.",
|
| - "Double precision floating point parameter.",
|
| - "Boolean parameter.",
|
| - "Record parameter.",
|
| - "Page ID for a Google+ Page."
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "recurse": {
|
| - "description": "If set to true, schema should be taken from the parent with the same\nparameter_id. Only applicable when parameter type is RECORD.",
|
| - "type": "boolean"
|
| - },
|
| - "description": {
|
| - "description": "Parameter description.",
|
| - "type": "string"
|
| - },
|
| - "allowedValues": {
|
| - "description": "All possible values for the parameter.",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ListTransferRunsResponse": {
|
| - "description": "The returned list of pipelines in the project.",
|
| - "id": "ListTransferRunsResponse",
|
| - "properties": {
|
| - "transferRuns": {
|
| - "description": "The stored pipeline transfer runs.\n@OutputOnly",
|
| - "items": {
|
| - "$ref": "TransferRun"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "nextPageToken": {
|
| - "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferRunsRequest.page_token`\nto request the next page of list results.\n@OutputOnly",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "IsEnabledRequest": {
|
| - "description": "A request to determine whether data transfer is enabled for the project.",
|
| - "id": "IsEnabledRequest",
|
| - "properties": {},
|
| - "type": "object"
|
| - },
|
| - "SetEnabledRequest": {
|
| - "description": "A request to set whether data transfer is enabled or disabled for a project.",
|
| - "id": "SetEnabledRequest",
|
| - "properties": {
|
| - "enabled": {
|
| - "description": "Whether data transfer should be enabled or disabled for the project.",
|
| - "type": "boolean"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "ListTransferConfigsResponse": {
|
| - "description": "The returned list of pipelines in the project.",
|
| - "id": "ListTransferConfigsResponse",
|
| - "properties": {
|
| - "transferConfigs": {
|
| - "description": "The stored pipeline transfer configurations.\n@OutputOnly",
|
| - "items": {
|
| - "$ref": "TransferConfig"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "nextPageToken": {
|
| - "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferConfigsRequest.page_token`\nto request the next page of list results.\n@OutputOnly",
|
| - "type": "string"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "IsEnabledResponse": {
|
| - "description": "A response to indicate whether data transfer is enabled for the project.",
|
| - "id": "IsEnabledResponse",
|
| - "properties": {
|
| - "enabled": {
|
| - "description": "Indicates whether the project is enabled.",
|
| - "type": "boolean"
|
| - }
|
| - },
|
| - "type": "object"
|
| - },
|
| - "DataSource": {
|
| - "description": "Represents data source metadata. Metadata is sufficient to\nrender UI and request proper OAuth tokens.",
|
| - "id": "DataSource",
|
| - "properties": {
|
| - "dataSourceId": {
|
| - "description": "Data source id.",
|
| - "type": "string"
|
| - },
|
| - "scopes": {
|
| - "description": "Api auth scopes for which refresh token needs to be obtained. Only valid\nwhen `client_id` is specified. Ignored otherwise. These are scopes needed\nby a data source to prepare data and ingest them into BigQuery,\ne.g., https://www.googleapis.com/auth/bigquery",
|
| - "items": {
|
| - "type": "string"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "name": {
|
| - "description": "Data source resource name.",
|
| - "type": "string"
|
| - },
|
| - "clientId": {
|
| - "description": "Data source client id which should be used to receive refresh token.\nWhen not supplied, no offline credentials are populated for data transfer.",
|
| - "type": "string"
|
| - },
|
| - "authorizationType": {
|
| - "description": "Indicates the type of authorization.",
|
| - "enum": [
|
| - "AUTHORIZATION_TYPE_UNSPECIFIED",
|
| - "AUTHORIZATION_CODE",
|
| - "GOOGLE_PLUS_AUTHORIZATION_CODE"
|
| - ],
|
| - "enumDescriptions": [
|
| - "Type unspecified.",
|
| - "Use OAuth 2 authorization codes that can be exchanged\nfor a refresh token on the backend.",
|
| - "Return an authorization code for a given Google+ page that can then be\nexchanged for a refresh token on the backend."
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "supportsCustomSchedule": {
|
| - "description": "Specifies whether the data source supports a user defined schedule, or\noperates on the default schedule.\nWhen set to `true`, user can override default schedule.",
|
| - "type": "boolean"
|
| - },
|
| - "displayName": {
|
| - "description": "User friendly data source name.",
|
| - "type": "string"
|
| - },
|
| - "dataRefreshType": {
|
| - "description": "Specifies whether the data source supports automatic data refresh for the\npast few days, and how it's supported.\nFor some data sources, data might not be complete until a few days later,\nso it's useful to refresh data automatically.",
|
| - "enum": [
|
| - "NONE",
|
| - "SLIDING_WINDOW",
|
| - "CUSTOM_SLIDING_WINDOW"
|
| - ],
|
| - "enumDescriptions": [
|
| - "The data source won't support data auto refresh, which is default value.",
|
| - "The data source supports data auto refresh, and runs will be scheduled\nfor the past few days. Does not allow custom values to be set for each\ntransfer config.",
|
| - "The data source supports data auto refresh, and runs will be scheduled\nfor the past few days. Allows custom values to be set for each transfer\nconfig."
|
| - ],
|
| - "type": "string"
|
| - },
|
| - "parameters": {
|
| - "description": "Data source parameters.",
|
| - "items": {
|
| - "$ref": "DataSourceParameter"
|
| - },
|
| - "type": "array"
|
| - },
|
| - "helpUrl": {
|
| - "description": "Url for the help document for this data source.",
|
| + "helpUrl": {
|
| + "description": "Url for the help document for this data source.",
|
| "type": "string"
|
| },
|
| "defaultSchedule": {
|
| "description": "Default data transfer schedule.\nExamples of valid schedules include:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.",
|
| "type": "string"
|
| },
|
| + "supportsMultipleTransfers": {
|
| + "description": "Indicates whether the data source supports multiple transfers\nto different BigQuery targets.",
|
| + "type": "boolean"
|
| + },
|
| "statusUpdateDeadlineSeconds": {
|
| "description": "The number of seconds to wait for a status update from the data source\nbefore BigQuery marks the transfer as failed.",
|
| "format": "int32",
|
| "type": "integer"
|
| },
|
| - "supportsMultipleTransfers": {
|
| - "description": "Indicates whether the data source supports multiple transfers\nto different BigQuery targets.",
|
| + "manualRunsDisabled": {
|
| + "description": "Disables backfilling and manual run scheduling\nfor the data source.",
|
| "type": "boolean"
|
| },
|
| "defaultDataRefreshWindowDays": {
|
| @@ -1462,10 +1270,6 @@
|
| "format": "int32",
|
| "type": "integer"
|
| },
|
| - "manualRunsDisabled": {
|
| - "description": "Disables backfilling and manual run scheduling\nfor the data source.",
|
| - "type": "boolean"
|
| - },
|
| "transferType": {
|
| "description": "Transfer type. Currently supports only batch transfers,\nwhich are transfers that use the BigQuery batch APIs (load or\nquery) to ingest the data.",
|
| "enum": [
|
| @@ -1483,6 +1287,10 @@
|
| "description": {
|
| "description": "User friendly data source description string.",
|
| "type": "string"
|
| + },
|
| + "dataSourceId": {
|
| + "description": "Data source id.",
|
| + "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1514,27 +1322,49 @@
|
| "description": "Represents a data transfer configuration. A transfer configuration\ncontains all metadata needed to perform a data transfer. For example,\n`destination_dataset_id` specifies where data should be stored.\nWhen a new transfer configuration is created, the specified\n`destination_dataset_id` is created when needed and shared with the\nappropriate data source service account.",
|
| "id": "TransferConfig",
|
| "properties": {
|
| + "datasetRegion": {
|
| + "description": "Region in which BigQuery dataset is located. Currently possible values are:\n\"US\" and \"EU\".\n@OutputOnly",
|
| + "type": "string"
|
| + },
|
| + "displayName": {
|
| + "description": "User specified display name for the data transfer.",
|
| + "type": "string"
|
| + },
|
| "nextRunTime": {
|
| "description": "Next time when data transfer will run. Output only. Applicable\nonly for batch data transfers.\n@OutputOnly",
|
| "format": "google-datetime",
|
| "type": "string"
|
| },
|
| - "dataSourceId": {
|
| - "description": "Data source id. Cannot be changed once data transfer is created.",
|
| - "type": "string"
|
| - },
|
| "disabled": {
|
| "description": "Is this config disabled. When set to true, no runs are scheduled\nfor a given transfer.",
|
| "type": "boolean"
|
| },
|
| - "status": {
|
| - "description": "Status of the most recently updated transfer run.\n@OutputOnly",
|
| - "enum": [
|
| - "TRANSFER_STATUS_UNSPECIFIED",
|
| - "INACTIVE",
|
| - "PENDING",
|
| - "RUNNING",
|
| - "SUCCEEDED",
|
| + "schedule": {
|
| + "description": "Data transfer schedule in GROC format.\nIf the data source does not support a custom schedule, this should be\nempty. If it is empty, the default value for the data source will be\nused.\nThe specified times are in UTC.\nExamples of valid GROC include:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.",
|
| + "type": "string"
|
| + },
|
| + "updateTime": {
|
| + "description": "Data transfer modification time. Ignored by server on input.\n@OutputOnly",
|
| + "format": "google-datetime",
|
| + "type": "string"
|
| + },
|
| + "dataRefreshWindowDays": {
|
| + "description": "The number of days to look back to automatically refresh the data.\nFor example, if `data_refresh_window_days = 10`, then every day\nBigQuery reingests data for [today-10, today-1], rather than ingesting data\nfor just [today-1].\nOnly valid if the data source supports the feature. Set the value to 0\nto use the default value.",
|
| + "format": "int32",
|
| + "type": "integer"
|
| + },
|
| + "dataSourceId": {
|
| + "description": "Data source id. Cannot be changed once data transfer is created.",
|
| + "type": "string"
|
| + },
|
| + "status": {
|
| + "description": "Status of the most recently updated transfer run.\n@OutputOnly",
|
| + "enum": [
|
| + "TRANSFER_STATUS_UNSPECIFIED",
|
| + "INACTIVE",
|
| + "PENDING",
|
| + "RUNNING",
|
| + "SUCCEEDED",
|
| "FAILED",
|
| "CANCELLED"
|
| ],
|
| @@ -1549,13 +1379,9 @@
|
| ],
|
| "type": "string"
|
| },
|
| - "updateTime": {
|
| - "description": "Data transfer modification time. Ignored by server on input.\n@OutputOnly",
|
| - "format": "google-datetime",
|
| - "type": "string"
|
| - },
|
| - "schedule": {
|
| - "description": "Data transfer schedule in GROC format.\nIf the data source does not support a custom schedule, this should be\nempty. If it is empty, the default value for the data source will be\nused.\nThe specified times are in UTC.\nExamples of valid GROC include:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.",
|
| + "userId": {
|
| + "description": "GaiaID of the user on whose behalf transfer is done. Applicable only\nto data sources that do not support service accounts. When set to 0,\nthe data source service account credentials are used.\n@OutputOnly",
|
| + "format": "int64",
|
| "type": "string"
|
| },
|
| "destinationDatasetId": {
|
| @@ -1573,15 +1399,6 @@
|
| },
|
| "description": "Data transfer specific parameters.",
|
| "type": "object"
|
| - },
|
| - "dataRefreshWindowDays": {
|
| - "description": "The number of days to look back to automatically refresh the data.\nFor example, if `data_refresh_window_days = 10`, then every day\nBigQuery reingests data for [today-10, today-1], rather than ingesting data\nfor just [today-1].\nOnly valid if the data source supports the feature. Set the value to 0\nto use the default value.",
|
| - "format": "int32",
|
| - "type": "integer"
|
| - },
|
| - "displayName": {
|
| - "description": "User specified display name for the data transfer.",
|
| - "type": "string"
|
| }
|
| },
|
| "type": "object"
|
| @@ -1590,26 +1407,43 @@
|
| "description": "Represents a data transfer run.",
|
| "id": "TransferRun",
|
| "properties": {
|
| - "updateTime": {
|
| - "description": "Last time the data transfer run status was updated.\n@OutputOnly",
|
| - "format": "google-datetime",
|
| + "dataSourceId": {
|
| + "description": "Data source id.\n@OutputOnly",
|
| "type": "string"
|
| },
|
| - "schedule": {
|
| - "description": "Describes the schedule of this transfer run if it was created as part of\na regular schedule. For batch transfer runs that are directly created,\nthis is empty.\nNOTE: the system might choose to delay the schedule depending on the\ncurrent load, so `schedule_time` doesn't always matches this.\n@OutputOnly",
|
| + "status": {
|
| + "description": "Data transfer run status. Ignored for input requests.\n@OutputOnly",
|
| + "enum": [
|
| + "TRANSFER_STATUS_UNSPECIFIED",
|
| + "INACTIVE",
|
| + "PENDING",
|
| + "RUNNING",
|
| + "SUCCEEDED",
|
| + "FAILED",
|
| + "CANCELLED"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Status placeholder.",
|
| + "Data transfer is inactive.",
|
| + "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.",
|
| + "Data transfer is in progress.",
|
| + "Data transfer completed successsfully.",
|
| + "Data transfer failed.",
|
| + "Data transfer is cancelled."
|
| + ],
|
| "type": "string"
|
| },
|
| - "destinationDatasetId": {
|
| - "description": "The BigQuery target dataset id.",
|
| + "userId": {
|
| + "description": "The user id for this transfer run.\n@OutputOnly",
|
| + "format": "int64",
|
| "type": "string"
|
| },
|
| "name": {
|
| - "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`.\nThe name is ignored when creating a transfer run.",
|
| + "description": "The resource name of the transfer run.\nTransfer run names have the form\n`projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.\nThe name is ignored when creating a transfer run.",
|
| "type": "string"
|
| },
|
| - "runTime": {
|
| - "description": "For batch transfer runs, specifies the date and time that\ndata should be ingested.",
|
| - "format": "google-datetime",
|
| + "destinationDatasetId": {
|
| + "description": "The BigQuery target dataset id.",
|
| "type": "string"
|
| },
|
| "params": {
|
| @@ -1630,8 +1464,8 @@
|
| "format": "google-datetime",
|
| "type": "string"
|
| },
|
| - "dataSourceId": {
|
| - "description": "Data source id.\n@OutputOnly",
|
| + "datasetRegion": {
|
| + "description": "Region in which BigQuery dataset is located. Currently possible values are:\n\"US\" and \"EU\".\n@OutputOnly",
|
| "type": "string"
|
| },
|
| "scheduleTime": {
|
| @@ -1639,36 +1473,278 @@
|
| "format": "google-datetime",
|
| "type": "string"
|
| },
|
| - "status": {
|
| - "description": "Data transfer run status. Ignored for input requests.\n@OutputOnly",
|
| + "schedule": {
|
| + "description": "Describes the schedule of this transfer run if it was created as part of\na regular schedule. For batch transfer runs that are directly created,\nthis is empty.\nNOTE: the system might choose to delay the schedule depending on the\ncurrent load, so `schedule_time` doesn't always matches this.\n@OutputOnly",
|
| + "type": "string"
|
| + },
|
| + "updateTime": {
|
| + "description": "Last time the data transfer run status was updated.\n@OutputOnly",
|
| + "format": "google-datetime",
|
| + "type": "string"
|
| + },
|
| + "runTime": {
|
| + "description": "For batch transfer runs, specifies the date and time that\ndata should be ingested.",
|
| + "format": "google-datetime",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "CheckValidCredsRequest": {
|
| + "description": "A request to determine whether the user has valid credentials. This method\nis used to limit the number of OAuth popups in the user interface. The\nuser id is inferred from the API call context.\nIf the data source has the Google+ authorization type, this method\nreturns false, as it cannot be determined whether the credentials are\nalready valid merely based on the user id.",
|
| + "id": "CheckValidCredsRequest",
|
| + "properties": {},
|
| + "type": "object"
|
| + },
|
| + "CheckValidCredsResponse": {
|
| + "description": "A response indicating whether the credentials exist and are valid.",
|
| + "id": "CheckValidCredsResponse",
|
| + "properties": {
|
| + "hasValidCreds": {
|
| + "description": "If set to `true`, the credentials exist and are valid.",
|
| + "type": "boolean"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ScheduleTransferRunsResponse": {
|
| + "description": "A response to schedule transfer runs for a time range.",
|
| + "id": "ScheduleTransferRunsResponse",
|
| + "properties": {
|
| + "createdRuns": {
|
| + "description": "The transfer runs that were created.",
|
| + "items": {
|
| + "$ref": "TransferRun"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ListTransferLogsResponse": {
|
| + "description": "The returned list transfer run messages.",
|
| + "id": "ListTransferLogsResponse",
|
| + "properties": {
|
| + "nextPageToken": {
|
| + "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`GetTransferRunLogRequest.page_token`\nto request the next page of list results.\n@OutputOnly",
|
| + "type": "string"
|
| + },
|
| + "transferMessages": {
|
| + "description": "The stored pipeline transfer messages.\n@OutputOnly",
|
| + "items": {
|
| + "$ref": "TransferMessage"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "TransferMessage": {
|
| + "description": "Represents a user facing message for a particular data transfer run.",
|
| + "id": "TransferMessage",
|
| + "properties": {
|
| + "messageText": {
|
| + "description": "Message text.",
|
| + "type": "string"
|
| + },
|
| + "severity": {
|
| + "description": "Message severity.",
|
| "enum": [
|
| - "TRANSFER_STATUS_UNSPECIFIED",
|
| - "INACTIVE",
|
| - "PENDING",
|
| - "RUNNING",
|
| - "SUCCEEDED",
|
| - "FAILED",
|
| - "CANCELLED"
|
| + "MESSAGE_SEVERITY_UNSPECIFIED",
|
| + "INFO",
|
| + "WARNING",
|
| + "ERROR"
|
| ],
|
| "enumDescriptions": [
|
| - "Status placeholder.",
|
| - "Data transfer is inactive.",
|
| - "Data transfer is scheduled and is waiting to be picked up by\ndata transfer backend.",
|
| - "Data transfer is in progress.",
|
| - "Data transfer completed successsfully.",
|
| - "Data transfer failed.",
|
| - "Data transfer is cancelled."
|
| + "No severity specified.",
|
| + "Informational message.",
|
| + "Warning message.",
|
| + "Error message."
|
| + ],
|
| + "type": "string"
|
| + },
|
| + "messageTime": {
|
| + "description": "Time when message was logged.",
|
| + "format": "google-datetime",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "ListDataSourcesResponse": {
|
| + "description": "Returns list of supported data sources and their metadata.",
|
| + "id": "ListDataSourcesResponse",
|
| + "properties": {
|
| + "nextPageToken": {
|
| + "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListDataSourcesRequest.page_token`\nto request the next page of list results.\n@OutputOnly",
|
| + "type": "string"
|
| + },
|
| + "dataSources": {
|
| + "description": "List of supported data sources and their transfer settings.",
|
| + "items": {
|
| + "$ref": "DataSource"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "DataSourceParameter": {
|
| + "description": "Represents a data source parameter with validation rules, so that\nparameters can be rendered in the UI. These parameters are given to us by\nsupported data sources, and include all needed information for rendering\nand validation.\nThus, whoever uses this api can decide to generate either generic ui,\nor custom data source specific forms.",
|
| + "id": "DataSourceParameter",
|
| + "properties": {
|
| + "fields": {
|
| + "description": "When parameter is a record, describes child fields.",
|
| + "items": {
|
| + "$ref": "DataSourceParameter"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "maxValue": {
|
| + "description": "For integer and double values specifies maxminum allowed value.",
|
| + "format": "double",
|
| + "type": "number"
|
| + },
|
| + "type": {
|
| + "description": "Parameter type.",
|
| + "enum": [
|
| + "TYPE_UNSPECIFIED",
|
| + "STRING",
|
| + "INTEGER",
|
| + "DOUBLE",
|
| + "BOOLEAN",
|
| + "RECORD",
|
| + "PLUS_PAGE"
|
| + ],
|
| + "enumDescriptions": [
|
| + "Type unspecified.",
|
| + "String parameter.",
|
| + "Integer parameter (64-bits).\nWill be serialized to json as string.",
|
| + "Double precision floating point parameter.",
|
| + "Boolean parameter.",
|
| + "Record parameter.",
|
| + "Page ID for a Google+ Page."
|
| ],
|
| "type": "string"
|
| + },
|
| + "recurse": {
|
| + "description": "If set to true, schema should be taken from the parent with the same\nparameter_id. Only applicable when parameter type is RECORD.",
|
| + "type": "boolean"
|
| + },
|
| + "description": {
|
| + "description": "Parameter description.",
|
| + "type": "string"
|
| + },
|
| + "allowedValues": {
|
| + "description": "All possible values for the parameter.",
|
| + "items": {
|
| + "type": "string"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "validationHelpUrl": {
|
| + "description": "URL to a help document to further explain the naming requirements.",
|
| + "type": "string"
|
| + },
|
| + "minValue": {
|
| + "description": "For integer and double values specifies minimum allowed value.",
|
| + "format": "double",
|
| + "type": "number"
|
| + },
|
| + "validationRegex": {
|
| + "description": "Regular expression which can be used for parameter validation.",
|
| + "type": "string"
|
| + },
|
| + "paramId": {
|
| + "description": "Parameter identifier.",
|
| + "type": "string"
|
| + },
|
| + "required": {
|
| + "description": "Is parameter required.",
|
| + "type": "boolean"
|
| + },
|
| + "repeated": {
|
| + "description": "Can parameter have multiple values.",
|
| + "type": "boolean"
|
| + },
|
| + "displayName": {
|
| + "description": "Parameter display name in the user interface.",
|
| + "type": "string"
|
| + },
|
| + "validationDescription": {
|
| + "description": "Description of the requirements for this field, in case the user input does\nnot fulfill the regex pattern or min/max values.",
|
| + "type": "string"
|
| + },
|
| + "immutable": {
|
| + "description": "Cannot be changed after initial creation.",
|
| + "type": "boolean"
|
| }
|
| },
|
| "type": "object"
|
| },
|
| - "CheckValidCredsRequest": {
|
| - "description": "A request to determine whether the user has valid credentials. This method\nis used to limit the number of OAuth popups in the user interface. The\nuser id is inferred from the API call context.\nIf the data source has the Google+ authorization type, this method\nreturns false, as it cannot be determined whether the credentials are\nalready valid merely based on the user id.",
|
| - "id": "CheckValidCredsRequest",
|
| + "ListTransferRunsResponse": {
|
| + "description": "The returned list of pipelines in the project.",
|
| + "id": "ListTransferRunsResponse",
|
| + "properties": {
|
| + "nextPageToken": {
|
| + "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferRunsRequest.page_token`\nto request the next page of list results.\n@OutputOnly",
|
| + "type": "string"
|
| + },
|
| + "transferRuns": {
|
| + "description": "The stored pipeline transfer runs.\n@OutputOnly",
|
| + "items": {
|
| + "$ref": "TransferRun"
|
| + },
|
| + "type": "array"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "IsEnabledRequest": {
|
| + "description": "A request to determine whether data transfer is enabled for the project.",
|
| + "id": "IsEnabledRequest",
|
| "properties": {},
|
| "type": "object"
|
| + },
|
| + "ListTransferConfigsResponse": {
|
| + "description": "The returned list of pipelines in the project.",
|
| + "id": "ListTransferConfigsResponse",
|
| + "properties": {
|
| + "transferConfigs": {
|
| + "description": "The stored pipeline transfer configurations.\n@OutputOnly",
|
| + "items": {
|
| + "$ref": "TransferConfig"
|
| + },
|
| + "type": "array"
|
| + },
|
| + "nextPageToken": {
|
| + "description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferConfigsRequest.page_token`\nto request the next page of list results.\n@OutputOnly",
|
| + "type": "string"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "SetEnabledRequest": {
|
| + "description": "A request to set whether data transfer is enabled or disabled for a project.",
|
| + "id": "SetEnabledRequest",
|
| + "properties": {
|
| + "enabled": {
|
| + "description": "Whether data transfer should be enabled or disabled for the project.",
|
| + "type": "boolean"
|
| + }
|
| + },
|
| + "type": "object"
|
| + },
|
| + "IsEnabledResponse": {
|
| + "description": "A response to indicate whether data transfer is enabled for the project.",
|
| + "id": "IsEnabledResponse",
|
| + "properties": {
|
| + "enabled": {
|
| + "description": "Indicates whether the project is enabled.",
|
| + "type": "boolean"
|
| + }
|
| + },
|
| + "type": "object"
|
| }
|
| },
|
| "servicePath": "",
|
|
|
Chromium Code Reviews
Issue 2973303002:
Api-Roll 51: 2017-07-10 (Closed)
