Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(48)

Issues Search
    My Issues | Starred     Open | Closed | All

Unified Diff: discovery/googleapis/bigquerydatatransfer__v1.json

Issue 2936613002: Api-Roll 50: 2017-06-12 (Closed)
Patch Set: Created 3 years, 6 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
« no previous file with comments | « discovery/googleapis/bigquery__v2.json ('k') | discovery/googleapis/calendar__v3.json » ('j') | no next file with comments »
Expand Comments ('e') | Collapse Comments ('c') | Show Comments Hide Comments ('s')
Index: discovery/googleapis/bigquerydatatransfer__v1.json
diff --git a/discovery/googleapis/bigquerydatatransfer__v1.json b/discovery/googleapis/bigquerydatatransfer__v1.json
index 81544f51442f01517d69ea3290d41ebb6fa5e700..d7c0381740ccc136202d53f5a122f6797ea4c8cc 100644
--- a/discovery/googleapis/bigquerydatatransfer__v1.json
+++ b/discovery/googleapis/bigquerydatatransfer__v1.json
@@ -11,7 +11,7 @@
"basePath": "",
"baseUrl": "https://bigquerydatatransfer.googleapis.com/",
"batchPath": "batch",
- "canonicalName": "BIGQUERYDATATRANSFER",
+ "canonicalName": "BigQuery Data Transfer",
"description": "Transfers data from partner SaaS applications to Google BigQuery on a scheduled, managed basis.",
"discoveryVersion": "v1",
"documentationLink": "https://cloud.google.com/bigquery/",
@@ -25,6 +25,45 @@
"ownerDomain": "google.com",
"ownerName": "Google",
"parameters": {
+ "upload_protocol": {
+ "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "prettyPrint": {
+ "default": "true",
+ "description": "Returns response with indentations and line breaks.",
+ "location": "query",
+ "type": "boolean"
+ },
+ "fields": {
+ "description": "Selector specifying which fields to include in a partial response.",
+ "location": "query",
+ "type": "string"
+ },
+ "uploadType": {
+ "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
+ "location": "query",
+ "type": "string"
+ },
+ "callback": {
+ "description": "JSONP",
+ "location": "query",
+ "type": "string"
+ },
+ "$.xgafv": {
+ "description": "V1 error format.",
+ "enum": [
+ "1",
+ "2"
+ ],
+ "enumDescriptions": [
+ "v1 error format",
+ "v2 error format"
+ ],
+ "location": "query",
+ "type": "string"
+ },
"alt": {
"default": "json",
"description": "Data format for response.",
@@ -71,45 +110,6 @@
"description": "OAuth bearer token.",
"location": "query",
"type": "string"
- },
- "upload_protocol": {
- "description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
- "location": "query",
- "type": "string"
- },
- "prettyPrint": {
- "default": "true",
- "description": "Returns response with indentations and line breaks.",
- "location": "query",
- "type": "boolean"
- },
- "uploadType": {
- "description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
- "location": "query",
- "type": "string"
- },
- "fields": {
- "description": "Selector specifying which fields to include in a partial response.",
- "location": "query",
- "type": "string"
- },
- "$.xgafv": {
- "description": "V1 error format.",
- "enum": [
- "1",
- "2"
- ],
- "enumDescriptions": [
- "v1 error format",
- "v2 error format"
- ],
- "location": "query",
- "type": "string"
- },
- "callback": {
- "description": "JSONP",
- "location": "query",
- "type": "string"
}
},
"protocol": "rest",
@@ -169,182 +169,685 @@
}
},
"resources": {
- "dataSources": {
+ "locations": {
"methods": {
- "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",
+ "isEnabled": {
+ "description": "Returns true if data transfer is enabled for a project.",
+ "httpMethod": "POST",
+ "id": "bigquerydatatransfer.projects.locations.isEnabled",
"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 name of the project resource in the form:\n`projects/{project_id}`",
"location": "path",
- "pattern": "^projects/[^/]+/dataSources/[^/]+$",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
"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": {
- "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"
- },
- "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"
- }
+ "path": "v1/{+name}:isEnabled",
+ "request": {
+ "$ref": "IsEnabledRequest"
},
- "path": "v1/{+parent}/dataSources",
"response": {
- "$ref": "ListDataSourcesResponse"
+ "$ref": "IsEnabledResponse"
},
"scopes": [
"https://www.googleapis.com/auth/bigquery"
]
},
- "checkValidCreds": {
- "description": "Returns true if valid credentials exist for the given data source and\nrequesting user.",
+ "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.dataSources.checkValidCreds",
+ "id": "bigquerydatatransfer.projects.locations.setEnabled",
"parameterOrder": [
"name"
],
"parameters": {
"name": {
- "description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`",
+ "description": "The name of the project resource in the form:\n`projects/{project_id}`",
"location": "path",
- "pattern": "^projects/[^/]+/dataSources/[^/]+$",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
"required": true,
"type": "string"
}
},
- "path": "v1/{+name}:checkValidCreds",
+ "path": "v1/{+name}:setEnabled",
"request": {
- "$ref": "CheckValidCredsRequest"
- },
- "response": {
- "$ref": "CheckValidCredsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery"
- ]
- }
- }
- },
- "transferConfigs": {
- "methods": {
- "delete": {
- "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs.",
- "httpMethod": "DELETE",
- "id": "bigquerydatatransfer.projects.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/[^/]+/transferConfigs/[^/]+$",
- "required": true,
- "type": "string"
- }
+ "$ref": "SetEnabledRequest"
},
- "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.transferConfigs.list",
- "parameterOrder": [
- "parent"
- ],
- "parameters": {
- "parent": {
- "description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
- "location": "path",
- "pattern": "^projects/[^/]+$",
- "required": true,
- "type": "string"
- },
- "dataSourceIds": {
- "description": "When specified, only configurations of requested data sources are returned.",
- "location": "query",
- "repeated": true,
- "type": "string"
- },
- "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"
+ }
+ }
+ },
+ "resources": {
+ "dataSources": {
+ "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",
+ "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"
+ ]
},
- "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",
- "response": {
- "$ref": "ListTransferConfigsResponse"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery"
- ]
- },
- "create": {
- "description": "Creates a new data transfer configuration.",
- "httpMethod": "POST",
- "id": "bigquerydatatransfer.projects.transferConfigs.create",
- "parameterOrder": [
- "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"
+ "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"
+ ]
},
- "parent": {
- "description": "The BigQuery project id where the transfer configuration should be created.",
+ "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": {
+ "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"
+ },
+ "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"
+ }
+ },
+ "path": "v1/{+parent}/dataSources",
+ "response": {
+ "$ref": "ListDataSourcesResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery"
+ ]
+ }
+ }
+ },
+ "transferConfigs": {
+ "methods": {
+ "create": {
+ "description": "Creates a new data transfer configuration.",
+ "httpMethod": "POST",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.create",
+ "parameterOrder": [
+ "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.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/transferConfigs",
+ "request": {
+ "$ref": "TransferConfig"
+ },
+ "response": {
+ "$ref": "TransferConfig"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery"
+ ]
+ },
+ "scheduleRuns": {
+ "description": "Creates transfer runs for a time range [range_start_time, range_end_time].\nFor each date - or whatever granularity the data source supports - in the\nrange, one transfer run is created.\nNote that runs are created per UTC time in the time range.",
+ "httpMethod": "POST",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}:scheduleRuns",
+ "request": {
+ "$ref": "ScheduleTransferRunsRequest"
+ },
+ "response": {
+ "$ref": "ScheduleTransferRunsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery"
+ ]
+ },
+ "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"
+ ]
+ },
+ "list": {
+ "description": "Returns information about running and completed jobs.",
+ "httpMethod": "GET",
+ "id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.list",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "pageToken": {
+ "description": "Pagination token, which can be used to request a specific page\nof `ListTransferRunsRequest` list results. For multiple-page\nresults, `ListTransferRunsResponse` 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"
+ },
+ "statuses": {
+ "description": "When specified, only transfer runs with requested statuses are returned.",
+ "enum": [
+ "TRANSFER_STATUS_UNSPECIFIED",
+ "INACTIVE",
+ "PENDING",
+ "RUNNING",
+ "SUCCEEDED",
+ "FAILED",
+ "CANCELLED"
+ ],
+ "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"
+ },
+ "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",
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/runs",
+ "response": {
+ "$ref": "ListTransferRunsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery"
+ ]
+ }
+ },
+ "resources": {
+ "transferLogs": {
+ "methods": {
+ "list": {
+ "description": "Returns user facing log messages for the data transfer run.",
+ "httpMethod": "GET",
+ "id": "bigquerydatatransfer.projects.locations.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": {
+ "description": "Message types to return. If not populated - INFO, WARNING and ERROR\nmessages are returned.",
+ "enum": [
+ "MESSAGE_SEVERITY_UNSPECIFIED",
+ "INFO",
+ "WARNING",
+ "ERROR"
+ ],
+ "location": "query",
+ "repeated": true,
+ "type": "string"
+ },
+ "parent": {
+ "description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.",
+ "location": "path",
+ "pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
+ "required": true,
+ "type": "string"
+ }
+ },
+ "path": "v1/{+parent}/transferLogs",
+ "response": {
+ "$ref": "ListTransferLogsResponse"
+ },
+ "scopes": [
+ "https://www.googleapis.com/auth/bigquery"
+ ]
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ }
+ },
+ "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"
+ },
+ "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"
+ ]
+ }
+ }
+ },
+ "transferConfigs": {
+ "methods": {
+ "delete": {
+ "description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs.",
+ "httpMethod": "DELETE",
+ "id": "bigquerydatatransfer.projects.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/[^/]+/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.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/[^/]+$",
"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"
+ ]
+ },
+ "create": {
+ "description": "Creates a new data transfer configuration.",
+ "httpMethod": "POST",
+ "id": "bigquerydatatransfer.projects.transferConfigs.create",
+ "parameterOrder": [
+ "parent"
+ ],
+ "parameters": {
+ "parent": {
+ "description": "The BigQuery project id where the transfer configuration should be created.",
+ "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",
@@ -430,27 +933,51 @@
"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"
- ]
- }
- },
- "resources": {
- "runs": {
- "methods": {
+ "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"
+ ]
+ }
+ },
+ "resources": {
+ "runs": {
+ "methods": {
+ "delete": {
+ "description": "Deletes the specified transfer run.",
+ "httpMethod": "DELETE",
+ "id": "bigquerydatatransfer.projects.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/[^/]+/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",
@@ -483,6 +1010,13 @@
"parent"
],
"parameters": {
+ "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",
+ "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
+ "required": true,
+ "type": "string"
+ },
"pageToken": {
"description": "Pagination token, which can be used to request a specific page\nof `ListTransferRunsRequest` list results. For multiple-page\nresults, `ListTransferRunsResponse` 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",
@@ -517,13 +1051,6 @@
],
"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",
- "pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
- "required": true,
- "type": "string"
}
},
"path": "v1/{+parent}/runs",
@@ -533,30 +1060,6 @@
"scopes": [
"https://www.googleapis.com/auth/bigquery"
]
- },
- "delete": {
- "description": "Deletes the specified transfer run.",
- "httpMethod": "DELETE",
- "id": "bigquerydatatransfer.projects.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/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
- "required": true,
- "type": "string"
- }
- },
- "path": "v1/{+name}",
- "response": {
- "$ref": "Empty"
- },
- "scopes": [
- "https://www.googleapis.com/auth/bigquery"
- ]
}
},
"resources": {
@@ -570,6 +1073,17 @@
"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": [
@@ -588,17 +1102,6 @@
"pattern": "^projects/[^/]+/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",
@@ -616,187 +1119,11 @@
}
}
}
- }
- },
- "revision": "20170519",
- "rootUrl": "https://bigquerydatatransfer.googleapis.com/",
- "schemas": {
- "Empty": {
- "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
- "id": "Empty",
- "properties": {},
- "type": "object"
- },
- "TransferConfig": {
- "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": {
- "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"
- ],
- "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.",
- "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.",
- "type": "string"
- },
- "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"
- },
- "params": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "Data transfer specific parameters.",
- "type": "object"
- },
- "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"
- },
- "disabled": {
- "description": "Is this config disabled. When set to true, no runs are scheduled\nfor a given transfer.",
- "type": "boolean"
- },
- "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"
- }
- },
- "type": "object"
- },
- "TransferRun": {
- "description": "Represents a data transfer run.",
- "id": "TransferRun",
- "properties": {
- "scheduleTime": {
- "description": "Minimum time after which a transfer run can be started.",
- "format": "google-datetime",
- "type": "string"
- },
- "updateTime": {
- "description": "Last time the data transfer run status was updated.\n@OutputOnly",
- "format": "google-datetime",
- "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",
- "type": "string"
- },
- "runTime": {
- "description": "For batch transfer runs, specifies the date and time that\ndata should be ingested.",
- "format": "google-datetime",
- "type": "string"
- },
- "dataSourceId": {
- "description": "Data source id.\n@OutputOnly",
- "type": "string"
- },
- "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"
- },
- "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.",
- "type": "string"
- },
- "destinationDatasetId": {
- "description": "The BigQuery target dataset id.",
- "type": "string"
- },
- "userId": {
- "description": "The user id for this transfer run.\n@OutputOnly",
- "format": "int64",
- "type": "string"
- },
- "params": {
- "additionalProperties": {
- "description": "Properties of the object.",
- "type": "any"
- },
- "description": "Data transfer specific parameters.",
- "type": "object"
- },
- "endTime": {
- "description": "Time when transfer run ended. Parameter ignored by server for input\nrequests.\n@OutputOnly",
- "format": "google-datetime",
- "type": "string"
- },
- "startTime": {
- "description": "Time when transfer run was started. Parameter ignored by server for input\nrequests.\n@OutputOnly",
- "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"
- },
+ }
+ },
+ "revision": "20170609",
+ "rootUrl": "https://bigquerydatatransfer.googleapis.com/",
+ "schemas": {
"CheckValidCredsResponse": {
"description": "A response indicating whether the credentials exist and are valid.",
"id": "CheckValidCredsResponse",
@@ -822,6 +1149,24 @@
},
"type": "object"
},
+ "ListTransferLogsResponse": {
+ "description": "The returned list transfer run messages.",
+ "id": "ListTransferLogsResponse",
+ "properties": {
+ "transferMessages": {
+ "description": "The stored pipeline transfer messages.\n@OutputOnly",
+ "items": {
+ "$ref": "TransferMessage"
+ },
+ "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",
@@ -854,24 +1199,6 @@
},
"type": "object"
},
- "ListTransferLogsResponse": {
- "description": "The returned list transfer run messages.",
- "id": "ListTransferLogsResponse",
- "properties": {
- "transferMessages": {
- "description": "The stored pipeline transfer messages.\n@OutputOnly",
- "items": {
- "$ref": "TransferMessage"
- },
- "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"
- },
"ListDataSourcesResponse": {
"description": "Returns list of supported data sources and their metadata.",
"id": "ListDataSourcesResponse",
@@ -894,26 +1221,15 @@
"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": {
- "description": {
- "description": "Parameter description.",
+ "validationHelpUrl": {
+ "description": "URL to a help document to further explain the naming requirements.",
"type": "string"
},
- "allowedValues": {
- "description": "All possible values for the parameter.",
- "items": {
- "type": "string"
- },
- "type": "array"
- },
"minValue": {
"description": "For integer and double values specifies minimum allowed value.",
"format": "double",
"type": "number"
},
- "validationHelpUrl": {
- "description": "URL to a help document to further explain the naming requirements.",
- "type": "string"
- },
"validationRegex": {
"description": "Regular expression which can be used for parameter validation.",
"type": "string"
@@ -934,14 +1250,14 @@
"description": "Parameter display name in the user interface.",
"type": "string"
},
- "immutable": {
- "description": "Cannot be changed after initial creation.",
- "type": "boolean"
- },
"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": {
@@ -979,6 +1295,17 @@
"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"
@@ -1121,17 +1448,13 @@
"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"
},
- "manualRunsDisabled": {
- "description": "Disables backfilling and manual run scheduling\nfor the data source.",
+ "supportsMultipleTransfers": {
+ "description": "Indicates whether the data source supports multiple transfers\nto different BigQuery targets.",
"type": "boolean"
},
"defaultDataRefreshWindowDays": {
@@ -1139,6 +1462,10 @@
"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": [
@@ -1164,18 +1491,184 @@
"description": "A request to schedule transfer runs for a time range.",
"id": "ScheduleTransferRunsRequest",
"properties": {
+ "rangeStartTime": {
+ "description": "Start time of the range of transfer runs.",
+ "format": "google-datetime",
+ "type": "string"
+ },
"rangeEndTime": {
"description": "End time of the range of transfer runs.",
"format": "google-datetime",
"type": "string"
+ }
+ },
+ "type": "object"
+ },
+ "Empty": {
+ "description": "A generic empty message that you can re-use to avoid defining duplicated\nempty messages in your APIs. A typical example is to use it as the request\nor the response type of an API method. For instance:\n\n service Foo {\n rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty);\n }\n\nThe JSON representation for `Empty` is empty JSON object `{}`.",
+ "id": "Empty",
+ "properties": {},
+ "type": "object"
+ },
+ "TransferConfig": {
+ "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": {
+ "nextRunTime": {
+ "description": "Next time when data transfer will run. Output only. Applicable\nonly for batch data transfers.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
},
- "rangeStartTime": {
- "description": "Start time of the range of transfer runs.",
+ "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",
+ "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"
+ },
+ "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`.",
+ "type": "string"
+ },
+ "destinationDatasetId": {
+ "description": "The BigQuery target dataset id.",
+ "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.",
+ "type": "string"
+ },
+ "params": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "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"
+ },
+ "TransferRun": {
+ "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",
+ "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",
+ "type": "string"
+ },
+ "destinationDatasetId": {
+ "description": "The BigQuery target dataset id.",
+ "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.",
+ "type": "string"
+ },
+ "runTime": {
+ "description": "For batch transfer runs, specifies the date and time that\ndata should be ingested.",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "params": {
+ "additionalProperties": {
+ "description": "Properties of the object.",
+ "type": "any"
+ },
+ "description": "Data transfer specific parameters.",
+ "type": "object"
+ },
+ "endTime": {
+ "description": "Time when transfer run ended. Parameter ignored by server for input\nrequests.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "startTime": {
+ "description": "Time when transfer run was started. Parameter ignored by server for input\nrequests.\n@OutputOnly",
+ "format": "google-datetime",
+ "type": "string"
+ },
+ "dataSourceId": {
+ "description": "Data source id.\n@OutputOnly",
+ "type": "string"
+ },
+ "scheduleTime": {
+ "description": "Minimum time after which a transfer run can be started.",
"format": "google-datetime",
"type": "string"
+ },
+ "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"
}
},
"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"
}
},
"servicePath": "",
« no previous file with comments | « discovery/googleapis/bigquery__v2.json ('k') | discovery/googleapis/calendar__v3.json » ('j') | no next file with comments »

Powered by Google App Engine
This is Rietveld 408576698