discovery/googleapis/bigquerydatatransfer__v1.json - Issue 2987103002: Api-Roll 52: 2017-07-31

Unified Diff: discovery/googleapis/bigquerydatatransfer__v1.json

Issue 2987103002: Api-Roll 52: 2017-07-31 (Closed)

Patch Set: Created 3 years, 5 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

Index: discovery/googleapis/bigquerydatatransfer__v1.json

diff --git a/discovery/googleapis/bigquerydatatransfer__v1.json b/discovery/googleapis/bigquerydatatransfer__v1.json

index 1e5d9fa14d596117cfb45d89f601c97acdaf1a12..663e849231734f01cccdc216467b6e39c234dc1e 100644

--- a/discovery/googleapis/bigquerydatatransfer__v1.json

+++ b/discovery/googleapis/bigquerydatatransfer__v1.json

@@ -2,14 +2,14 @@

"auth": {

"oauth2": {

"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"

+ },

+ "https://www.googleapis.com/auth/bigquery": {

+ "description": "View and manage your data in Google BigQuery"

}

@@ -31,27 +31,6 @@

"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",

@@ -116,16 +95,37 @@

"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"

}

"protocol": "rest",

"resources": {

"projects": {

"methods": {

- "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"

@@ -138,21 +138,23 @@

"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/cloud-platform"

+ "https://www.googleapis.com/auth/bigquery",

+ "https://www.googleapis.com/auth/cloud-platform",

+ "https://www.googleapis.com/auth/cloud-platform.read-only"

]

- "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"

@@ -165,17 +167,15 @@

"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",

- "https://www.googleapis.com/auth/cloud-platform.read-only"

+ "https://www.googleapis.com/auth/cloud-platform"

]

}

@@ -242,71 +242,6 @@

"resources": {

"transferConfigs": {

"methods": {

- "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",

- "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": "TransferConfig"

- },

- "response": {

- "$ref": "TransferConfig"

- },

- "scopes": [

- "https://www.googleapis.com/auth/bigquery",

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

- ]

- },

"delete": {

"description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs.",

"httpMethod": "DELETE",

@@ -340,6 +275,17 @@

"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"

+ },

"dataSourceIds": {

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

"location": "query",

@@ -352,17 +298,6 @@

"pattern": "^projects/[^/]+/locations/[^/]+$",

"required": 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"

- },

- "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",

@@ -435,6 +370,71 @@

"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": {

+ "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"

+ },

+ "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/cloud-platform"

+ ]

+ },

+ "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",

+ "https://www.googleapis.com/auth/cloud-platform",

+ "https://www.googleapis.com/auth/cloud-platform.read-only"

+ ]

}

"resources": {

@@ -564,6 +564,12 @@

"parent"

"parameters": {

+ "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": [

@@ -587,12 +593,6 @@

"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",

@@ -744,6 +744,12 @@

"parent"

"parameters": {

+ "pageSize": {

+ "description": "Page size. The default page size is the maximum value of 1000 results.",

+ "format": "int32",

+ "location": "query",

+ "type": "integer"

+ },

"dataSourceIds": {

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

"location": "query",

@@ -761,12 +767,6 @@

"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"

}

"path": "v1/{+parent}/transferConfigs",

@@ -840,55 +840,53 @@

"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": {

"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"

- },

- "authorizationCode": {

- "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/cloud-platform"

+ "https://www.googleapis.com/auth/cloud-platform",

+ "https://www.googleapis.com/auth/cloud-platform.read-only"

]

- "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": {

+ "authorizationCode": {

+ "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 field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",

"location": "path",

"pattern": "^projects/[^/]+/transferConfigs/[^/]+$",

"required": true,

@@ -896,44 +894,21 @@

}

"path": "v1/{+name}",

+ "request": {

+ "$ref": "TransferConfig"

+ },

"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"

+ "https://www.googleapis.com/auth/cloud-platform"

]

}

"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",

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

- ]

- },

"list": {

"description": "Returns information about running and completed jobs.",

"httpMethod": "GET",

@@ -942,22 +917,6 @@

"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",

- "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",

@@ -983,6 +942,22 @@

"location": "query",

"repeated": true,

"type": "string"

+ },

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

+ "required": true,

+ "type": "string"

}

"path": "v1/{+parent}/runs",

@@ -1020,6 +995,31 @@

"https://www.googleapis.com/auth/cloud-platform",

"https://www.googleapis.com/auth/cloud-platform.read-only"

]

+ },

+ "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",

+ "https://www.googleapis.com/auth/cloud-platform"

+ ]

}

"resources": {

@@ -1179,226 +1179,90 @@

}

- "revision": "20170703",

+ "revision": "20170724",

"rootUrl": "https://bigquerydatatransfer.googleapis.com/",

"schemas": {

- "DataSource": {

- "description": "Represents data source metadata. Metadata is sufficient to\nrender UI and request proper OAuth tokens.",

- "id": "DataSource",

+ "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": {

- "name": {

- "description": "Data source resource name.",

+ "displayName": {

+ "description": "User specified display name for the data transfer.",

"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"

+ "nextRunTime": {

+ "description": "Next time when data transfer will run. Output only. Applicable\nonly for batch data transfers.\n@OutputOnly",

+ "format": "google-datetime",

+ "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.",

+ "disabled": {

+ "description": "Is this config disabled. When set to true, no runs are scheduled\nfor a given transfer.",

+ "type": "boolean"

+ },

+ "updateTime": {

+ "description": "Data transfer modification time. Ignored by server on input.\n@OutputOnly",

+ "format": "google-datetime",

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

- ],

+ "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"

- "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"

+ "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 friendly data source name.",

+ "dataSourceId": {

+ "description": "Data source id. Cannot be changed once data transfer is created.",

"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.",

+ "status": {

+ "description": "Status of the most recently updated transfer run.\n@OutputOnly",

"enum": [

- "NONE",

- "SLIDING_WINDOW",

- "CUSTOM_SLIDING_WINDOW"

+ "TRANSFER_STATUS_UNSPECIFIED",

+ "INACTIVE",

+ "PENDING",

+ "RUNNING",

+ "SUCCEEDED",

+ "FAILED",

+ "CANCELLED"

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

+ "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"

- "parameters": {

- "description": "Data source parameters.",

- "items": {

- "$ref": "DataSourceParameter"

- },

- "type": "array"

- },

- "helpUrl": {

- "description": "Url for the help document for this data source.",

+ "name": {

"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`.",

+ "destinationDatasetId": {

+ "description": "The BigQuery target dataset id.",

"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.",

- "type": "boolean"

+ "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"

- "defaultDataRefreshWindowDays": {

- "description": "Default data refresh window on days.\nOnly meaningful when `data_refresh_type` = `SLIDING_WINDOW`.",

- "format": "int32",

- "type": "integer"

+ "params": {

+ "additionalProperties": {

+ "description": "Properties of the object.",

+ "type": "any"

+ },

+ "description": "Data transfer specific parameters.",

+ "type": "object"

- "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": [

- "TRANSFER_TYPE_UNSPECIFIED",

- "BATCH",

- "STREAMING"

- ],

- "enumDescriptions": [

- "Invalid or Unknown transfer type placeholder.",

- "Batch data transfer.",

- "Streaming data transfer. Streaming data source currently doesn't\nsupport multiple transfer configs per project."

- ],

- "type": "string"

- },

- "description": {

- "description": "User friendly data source description string.",

- "type": "string"

- },

- "dataSourceId": {

- "description": "Data source id.",

- "type": "string"

- }

- },

- "type": "object"

- },

- "ScheduleTransferRunsRequest": {

- "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": {

"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"

- },

- "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"

- },

- "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"

- },

- "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": {

- "description": "The BigQuery target dataset id.",

- "type": "string"

- },

- "name": {

- "type": "string"

- },

- "params": {

- "additionalProperties": {

- "description": "Properties of the object.",

- "type": "any"

- },

- "description": "Data transfer specific parameters.",

- "type": "object"

}

"type": "object"

@@ -1407,6 +1271,11 @@

"description": "Represents a data transfer run.",

"id": "TransferRun",

"properties": {

+ "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"

@@ -1433,15 +1302,15 @@

"type": "string"

+ "name": {

+ "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"

+ },

"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}/locations/{location}/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"

@@ -1459,15 +1328,15 @@

"format": "google-datetime",

"type": "string"

+ "datasetRegion": {

+ "description": "Region in which BigQuery dataset is located. Currently possible values are:\n\"US\" and \"EU\".\n@OutputOnly",

+ "type": "string"

+ },

"startTime": {

"description": "Time when transfer run was started. Parameter ignored by server for input\nrequests.\n@OutputOnly",

"format": "google-datetime",

"type": "string"

- "datasetRegion": {

- "description": "Region in which BigQuery dataset is located. Currently possible values are:\n\"US\" and \"EU\".\n@OutputOnly",

- "type": "string"

- },

"scheduleTime": {

"description": "Minimum time after which a transfer run can be started.",

"format": "google-datetime",

@@ -1481,11 +1350,6 @@

"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"

@@ -1521,24 +1385,6 @@

"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",

@@ -1571,20 +1417,38 @@

"type": "object"

- "ListDataSourcesResponse": {

- "description": "Returns list of supported data sources and their metadata.",

- "id": "ListDataSourcesResponse",

+ "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`ListDataSourcesRequest.page_token`\nto request the next page of list results.\n@OutputOnly",

+ "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"

+ },

+ "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.",

"items": {

"$ref": "DataSource"

"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"

@@ -1593,44 +1457,6 @@

"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"

@@ -1671,12 +1497,50 @@

"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.",

+ "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"

}

@@ -1686,16 +1550,16 @@

"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"

+ },

+ "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"

@@ -1706,6 +1570,17 @@

"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",

@@ -1724,27 +1599,152 @@

"type": "object"

- "SetEnabledRequest": {

- "description": "A request to set whether data transfer is enabled or disabled for a project.",

- "id": "SetEnabledRequest",

+ "IsEnabledResponse": {

+ "description": "A response to indicate whether data transfer is enabled for the project.",

+ "id": "IsEnabledResponse",

"properties": {

"enabled": {

- "description": "Whether data transfer should be enabled or disabled for the project.",

+ "description": "Indicates whether the project is enabled.",

"type": "boolean"

}

"type": "object"

- "IsEnabledResponse": {

- "description": "A response to indicate whether data transfer is enabled for the project.",

- "id": "IsEnabledResponse",

+ "DataSource": {

+ "description": "Represents data source metadata. Metadata is sufficient to\nrender UI and request proper OAuth tokens.",

+ "id": "DataSource",

"properties": {

- "enabled": {

- "description": "Indicates whether the project is enabled.",

+ "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"

+ },

+ "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.",

"type": "boolean"

+ },

+ "defaultDataRefreshWindowDays": {

+ "description": "Default data refresh window on days.\nOnly meaningful when `data_refresh_type` = `SLIDING_WINDOW`.",

+ "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": [

+ "TRANSFER_TYPE_UNSPECIFIED",

+ "BATCH",

+ "STREAMING"

+ ],

+ "enumDescriptions": [

+ "Invalid or Unknown transfer type placeholder.",

+ "Batch data transfer.",

+ "Streaming data transfer. Streaming data source currently doesn't\nsupport multiple transfer configs per project."

+ ],

+ "type": "string"

+ },

+ "description": {

+ "description": "User friendly data source description string.",

+ "type": "string"

+ },

+ "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"

}

"type": "object"

+ },

+ "ScheduleTransferRunsRequest": {

+ "description": "A request to schedule transfer runs for a time range.",

+ "id": "ScheduleTransferRunsRequest",

+ "properties": {

+ "rangeEndTime": {

+ "description": "End time of the range of transfer runs.",

+ "format": "google-datetime",

+ "type": "string"

+ },

+ "rangeStartTime": {

+ "description": "Start 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"

}

"servicePath": "",

« no previous file with comments | « discovery/googleapis/bigquery__v2.json ('k') | discovery/googleapis/calendar__v3.json » ('j') | no next file with comments »