octoleo/restic
2
2
Fork 0
mirror of https://github.com/octoleo/restic.git synced 2024-11-15 09:44:15 +00:00
Code Issues Releases Wiki Activity
ba23d24dd1
restic/vendor/google.golang.org/api/bigquerydatatransfer/v1/bigquerydatatransfer-api.json
Alexander Neumann 02fc16e97d Update vendored dependencies
2017-09-21 17:48:45 +02:00

1762 lines
82 KiB
JSON
Raw Blame History

{
"version_module": true,
"schemas": {
"ScheduleTransferRunsResponse": {
"description": "A response to schedule transfer runs for a time range.",
"type": "object",
"properties": {
"runs": {
"items": {
"$ref": "TransferRun"
},
"type": "array",
"description": "The transfer runs that were scheduled."
}
},
"id": "ScheduleTransferRunsResponse"
},
"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.\nOutput only.",
"type": "string"
},
"transferMessages": {
"description": "The stored pipeline transfer messages.\nOutput only.",
"items": {
"$ref": "TransferMessage"
},
"type": "array"
}
},
"id": "ListTransferLogsResponse",
"description": "The returned list transfer run messages.",
"type": "object"
},
"TransferMessage": {
"id": "TransferMessage",
"description": "Represents a user facing message for a particular data transfer run.",
"type": "object",
"properties": {
"messageText": {
"description": "Message text.",
"type": "string"
},
"severity": {
"description": "Message severity.",
"type": "string",
"enumDescriptions": [
"No severity specified.",
"Informational message.",
"Warning message.",
"Error message."
],
"enum": [
"MESSAGE_SEVERITY_UNSPECIFIED",
"INFO",
"WARNING",
"ERROR"
]
},
"messageTime": {
"format": "google-datetime",
"description": "Time when message was logged.",
"type": "string"
}
}
},
"ListDataSourcesResponse": {
"description": "Returns list of supported data sources and their metadata.",
"type": "object",
"properties": {
"dataSources": {
"items": {
"$ref": "DataSource"
},
"type": "array",
"description": "List of supported data sources and their transfer settings."
},
"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.\nOutput only.",
"type": "string"
}
},
"id": "ListDataSourcesResponse"
},
"DataSourceParameter": {
"description": "Represents a data source parameter with validation rules, so that\nparameters can be rendered in the UI. These parameters are given to us by\nsupported data sources, and include all needed information for rendering\nand validation.\nThus, whoever uses this api can decide to generate either generic ui,\nor custom data source specific forms.",
"type": "object",
"properties": {
"recurse": {
"description": "If set to true, schema should be taken from the parent with the same\nparameter_id. Only applicable when parameter type is RECORD.",
"type": "boolean"
},
"description": {
"description": "Parameter description.",
"type": "string"
},
"allowedValues": {
"description": "All possible values for the parameter.",
"items": {
"type": "string"
},
"type": "array"
},
"validationHelpUrl": {
"description": "URL to a help document to further explain the naming requirements.",
"type": "string"
},
"minValue": {
"format": "double",
"description": "For integer and double values specifies minimum allowed value.",
"type": "number"
},
"validationRegex": {
"description": "Regular expression which can be used for parameter validation.",
"type": "string"
},
"paramId": {
"description": "Parameter identifier.",
"type": "string"
},
"required": {
"description": "Is parameter required.",
"type": "boolean"
},
"repeated": {
"type": "boolean",
"description": "Can parameter have multiple values."
},
"displayName": {
"description": "Parameter display name in the user interface.",
"type": "string"
},
"validationDescription": {
"description": "Description of the requirements for this field, in case the user input does\nnot fulfill the regex pattern or min/max values.",
"type": "string"
},
"immutable": {
"description": "Cannot be changed after initial creation.",
"type": "boolean"
},
"fields": {
"description": "When parameter is a record, describes child fields.",
"items": {
"$ref": "DataSourceParameter"
},
"type": "array"
},
"maxValue": {
"format": "double",
"description": "For integer and double values specifies maxminum allowed value.",
"type": "number"
},
"type": {
"description": "Parameter type.",
"type": "string",
"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."
],
"enum": [
"TYPE_UNSPECIFIED",
"STRING",
"INTEGER",
"DOUBLE",
"BOOLEAN",
"RECORD",
"PLUS_PAGE"
]
}
},
"id": "DataSourceParameter"
},
"ListTransferRunsResponse": {
"type": "object",
"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.\nOutput only.",
"type": "string"
},
"transferRuns": {
"description": "The stored pipeline transfer runs.\nOutput only.",
"items": {
"$ref": "TransferRun"
},
"type": "array"
}
},
"id": "ListTransferRunsResponse",
"description": "The returned list of pipelines in the project."
},
"ListLocationsResponse": {
"description": "The response message for Locations.ListLocations.",
"type": "object",
"properties": {
"locations": {
"description": "A list of locations that matches the specified filter in the request.",
"items": {
"$ref": "Location"
},
"type": "array"
},
"nextPageToken": {
"description": "The standard List next-page token.",
"type": "string"
}
},
"id": "ListLocationsResponse"
},
"ListTransferConfigsResponse": {
"type": "object",
"properties": {
"transferConfigs": {
"items": {
"$ref": "TransferConfig"
},
"type": "array",
"description": "The stored pipeline transfer configurations.\nOutput only."
},
"nextPageToken": {
"description": "The next-pagination token. For multiple-page list results,\nthis token can be used as the\n`ListTransferConfigsRequest.page_token`\nto request the next page of list results.\nOutput only.",
"type": "string"
}
},
"id": "ListTransferConfigsResponse",
"description": "The returned list of pipelines in the project."
},
"DataSource": {
"description": "Represents data source metadata. Metadata is sufficient to\nrender UI and request proper OAuth tokens.",
"type": "object",
"properties": {
"minimumScheduleInterval": {
"format": "google-duration",
"description": "The minimum interval between two consecutive scheduled runs.",
"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": {
"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."
],
"enum": [
"AUTHORIZATION_TYPE_UNSPECIFIED",
"AUTHORIZATION_CODE",
"GOOGLE_PLUS_AUTHORIZATION_CODE"
],
"description": "Indicates the type of authorization.",
"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": {
"type": "string",
"description": "User friendly data source name."
},
"updateDeadlineSeconds": {
"format": "int32",
"description": "The number of seconds to wait for an update from the data source\nbefore BigQuery marks the transfer as failed.",
"type": "integer"
},
"dataRefreshType": {
"enum": [
"DATA_REFRESH_TYPE_UNSPECIFIED",
"SLIDING_WINDOW",
"CUSTOM_SLIDING_WINDOW"
],
"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.",
"type": "string",
"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."
]
},
"parameters": {
"description": "Data source parameters.",
"items": {
"$ref": "DataSourceParameter"
},
"type": "array"
},
"helpUrl": {
"description": "Url for the help document for this data source.",
"type": "string"
},
"defaultSchedule": {
"description": "Default data transfer schedule.\nExamples of valid schedules include:\n`1st,3rd monday of month 15:30`,\n`every wed,fri of jan,jun 13:15`, and\n`first sunday of quarter 00:00`.",
"type": "string"
},
"supportsMultipleTransfers": {
"description": "Indicates whether the data source supports multiple transfers\nto different BigQuery targets.",
"type": "boolean"
},
"defaultDataRefreshWindowDays": {
"format": "int32",
"description": "Default data refresh window on days.\nOnly meaningful when `data_refresh_type` = `SLIDING_WINDOW`.",
"type": "integer"
},
"manualRunsDisabled": {
"description": "Disables backfilling and manual run scheduling\nfor the data source.",
"type": "boolean"
},
"transferType": {
"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."
],
"enum": [
"TRANSFER_TYPE_UNSPECIFIED",
"BATCH",
"STREAMING"
],
"description": "Transfer type. Currently supports only batch transfers,\nwhich are transfers that use the BigQuery batch APIs (load or\nquery) to ingest the data.",
"type": "string"
},
"description": {
"description": "User friendly data source description string.",
"type": "string"
},
"dataSourceId": {
"description": "Data source id.",
"type": "string"
},
"name": {
"description": "Data source resource name.",
"type": "string"
},
"scopes": {
"description": "Api auth scopes for which refresh token needs to be obtained. Only valid\nwhen `client_id` is specified. Ignored otherwise. These are scopes needed\nby a data source to prepare data and ingest them into BigQuery,\ne.g., https://www.googleapis.com/auth/bigquery",
"items": {
"type": "string"
},
"type": "array"
}
},
"id": "DataSource"
},
"ScheduleTransferRunsRequest": {
"type": "object",
"properties": {
"endTime": {
"format": "google-datetime",
"description": "End time of the range of transfer runs. For example,\n`\"2017-05-30T00:00:00+00:00\"`.",
"type": "string"
},
"startTime": {
"format": "google-datetime",
"description": "Start time of the range of transfer runs. For example,\n`\"2017-05-25T00:00:00+00:00\"`.",
"type": "string"
}
},
"id": "ScheduleTransferRunsRequest",
"description": "A request to schedule transfer runs for a time range."
},
"Empty": {
"properties": {},
"id": "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 `{}`.",
"type": "object"
},
"Location": {
"description": "A resource that represents Google Cloud Platform location.",
"type": "object",
"properties": {
"locationId": {
"description": "The canonical id for this location. For example: `\"us-east1\"`.",
"type": "string"
},
"metadata": {
"additionalProperties": {
"description": "Properties of the object. Contains field @type with type URL.",
"type": "any"
},
"description": "Service-specific metadata. For example the available capacity at the given\nlocation.",
"type": "object"
},
"labels": {
"additionalProperties": {
"type": "string"
},
"description": "Cross-service attributes for the location. For example\n\n {\"cloud.googleapis.com/region\": \"us-east1\"}",
"type": "object"
},
"name": {
"description": "Resource name for the location, which may vary between implementations.\nFor example: `\"projects/example-project/locations/us-east1\"`",
"type": "string"
}
},
"id": "Location"
},
"TransferConfig": {
"id": "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.",
"type": "object",
"properties": {
"datasetRegion": {
"description": "Region in which BigQuery dataset is located. Currently possible values are:\n\"US\" and \"EU\".\nOutput only.",
"type": "string"
},
"displayName": {
"description": "User specified display name for the data transfer.",
"type": "string"
},
"disabled": {
"description": "Is this config disabled. When set to true, no runs are scheduled\nfor a given transfer.",
"type": "boolean"
},
"nextRunTime": {
"format": "google-datetime",
"description": "Next time when data transfer will run.\nOutput only.",
"type": "string"
},
"updateTime": {
"type": "string",
"format": "google-datetime",
"description": "Data transfer modification time. Ignored by server on input.\nOutput only."
},
"schedule": {
"description": "Data transfer schedule.\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 format:\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`.\nSee more explanation about the format here:\nhttps://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format\nNOTE: the granularity should be at least 8 hours, or less frequent.",
"type": "string"
},
"dataRefreshWindowDays": {
"format": "int32",
"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.",
"type": "integer"
},
"dataSourceId": {
"description": "Data source id. Cannot be changed once data transfer is created.",
"type": "string"
},
"state": {
"enum": [
"TRANSFER_STATE_UNSPECIFIED",
"INACTIVE",
"PENDING",
"RUNNING",
"SUCCEEDED",
"FAILED",
"CANCELLED"
],
"description": "State of the most recently updated transfer run.\nOutput only.",
"type": "string",
"enumDescriptions": [
"State 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."
]
},
"name": {
"type": "string",
"description": "The resource name of the transfer config.\nTransfer config 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\nconfig."
},
"userId": {
"format": "int64",
"description": "Unique ID 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.\nOutput only.",
"type": "string"
},
"destinationDatasetId": {
"description": "The BigQuery target dataset id.",
"type": "string"
},
"params": {
"type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Data transfer specific parameters."
}
}
},
"TransferRun": {
"description": "Represents a data transfer run.",
"type": "object",
"properties": {
"dataSourceId": {
"description": "Data source id.\nOutput only.",
"type": "string"
},
"state": {
"type": "string",
"enumDescriptions": [
"State 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."
],
"enum": [
"TRANSFER_STATE_UNSPECIFIED",
"INACTIVE",
"PENDING",
"RUNNING",
"SUCCEEDED",
"FAILED",
"CANCELLED"
],
"description": "Data transfer run state. Ignored for input requests.\nOutput only."
},
"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}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.\nThe name is ignored when creating a transfer run.",
"type": "string"
},
"userId": {
"format": "int64",
"description": "Unique ID 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.\nOutput only.",
"type": "string"
},
"params": {
"type": "object",
"additionalProperties": {
"description": "Properties of the object.",
"type": "any"
},
"description": "Data transfer specific parameters."
},
"endTime": {
"format": "google-datetime",
"description": "Time when transfer run ended. Parameter ignored by server for input\nrequests.\nOutput only.",
"type": "string"
},
"datasetRegion": {
"description": "Region in which BigQuery dataset is located. Currently possible values are:\n\"US\" and \"EU\".\nOutput only.",
"type": "string"
},
"startTime": {
"format": "google-datetime",
"description": "Time when transfer run was started. Parameter ignored by server for input\nrequests.\nOutput only.",
"type": "string"
},
"scheduleTime": {
"format": "google-datetime",
"description": "Minimum time after which a transfer run can be started.",
"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.\nOutput only.",
"type": "string"
},
"updateTime": {
"type": "string",
"format": "google-datetime",
"description": "Last time the data transfer run state was updated.\nOutput only."
},
"runTime": {
"type": "string",
"format": "google-datetime",
"description": "For batch transfer runs, specifies the date and time that\ndata should be ingested."
}
},
"id": "TransferRun"
},
"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.",
"type": "object",
"properties": {},
"id": "CheckValidCredsRequest"
},
"CheckValidCredsResponse": {
"description": "A response indicating whether the credentials exist and are valid.",
"type": "object",
"properties": {
"hasValidCreds": {
"description": "If set to `true`, the credentials exist and are valid.",
"type": "boolean"
}
},
"id": "CheckValidCredsResponse"
}
},
"icons": {
"x16": "http://www.google.com/images/icons/product/search-16.gif",
"x32": "http://www.google.com/images/icons/product/search-32.gif"
},
"protocol": "rest",
"canonicalName": "BigQuery Data Transfer",
"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"
}
}
}
},
"rootUrl": "https://bigquerydatatransfer.googleapis.com/",
"ownerDomain": "google.com",
"name": "bigquerydatatransfer",
"batchPath": "batch",
"title": "BigQuery Data Transfer API",
"ownerName": "Google",
"resources": {
"projects": {
"resources": {
"transferConfigs": {
"methods": {
"delete": {
"httpMethod": "DELETE",
"parameterOrder": [
"name"
],
"response": {
"$ref": "Empty"
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
"path": "v1/{+name}",
"id": "bigquerydatatransfer.projects.transferConfigs.delete",
"description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs."
},
"list": {
"path": "v1/{+parent}/transferConfigs",
"id": "bigquerydatatransfer.projects.transferConfigs.list",
"description": "Returns information about all data transfers in the project.",
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "ListTransferConfigsResponse"
},
"parameters": {
"pageToken": {
"location": "query",
"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.",
"type": "string"
},
"pageSize": {
"type": "integer",
"location": "query",
"format": "int32",
"description": "Page size. The default page size is the maximum value of 1000 results."
},
"dataSourceIds": {
"location": "query",
"description": "When specified, only configurations of requested data sources are returned.",
"type": "string",
"repeated": true
},
"parent": {
"description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1/projects/{projectsId}/transferConfigs"
},
"create": {
"httpMethod": "POST",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "TransferConfig"
},
"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=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\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.",
"type": "string",
"location": "query"
},
"parent": {
"pattern": "^projects/[^/]+$",
"location": "path",
"description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format /projects/{project_id}/locations/{location_id}\nor\n/projects/{project_id}/locations/-\nIn case when '-' is specified as location_id, location is infered from\nthe destination dataset region.",
"type": "string",
"required": true
}
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/transferConfigs",
"path": "v1/{+parent}/transferConfigs",
"id": "bigquerydatatransfer.projects.transferConfigs.create",
"description": "Creates a new data transfer configuration.",
"request": {
"$ref": "TransferConfig"
}
},
"scheduleRuns": {
"response": {
"$ref": "ScheduleTransferRunsResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"parameters": {
"parent": {
"description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}:scheduleRuns",
"id": "bigquerydatatransfer.projects.transferConfigs.scheduleRuns",
"path": "v1/{+parent}: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.",
"request": {
"$ref": "ScheduleTransferRunsRequest"
}
},
"patch": {
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"updateMask": {
"location": "query",
"format": "google-fieldmask",
"description": "Required list of fields to be updated in this request.",
"type": "string"
},
"name": {
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
"location": "path",
"description": "The resource name of the transfer config.\nTransfer config 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\nconfig."
},
"authorizationCode": {
"location": "query",
"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=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\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.",
"type": "string"
}
},
"flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}",
"id": "bigquerydatatransfer.projects.transferConfigs.patch",
"path": "v1/{+name}",
"request": {
"$ref": "TransferConfig"
},
"description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated.",
"response": {
"$ref": "TransferConfig"
},
"parameterOrder": [
"name"
],
"httpMethod": "PATCH"
},
"get": {
"id": "bigquerydatatransfer.projects.transferConfigs.get",
"path": "v1/{+name}",
"description": "Returns information about a data transfer config.",
"response": {
"$ref": "TransferConfig"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"name": {
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}"
}
},
"resources": {
"runs": {
"methods": {
"delete": {
"description": "Deletes the specified transfer run.",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
"httpMethod": "DELETE",
"parameters": {
"name": {
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
"id": "bigquerydatatransfer.projects.transferConfigs.runs.delete",
"path": "v1/{+name}"
},
"list": {
"description": "Returns information about running and completed jobs.",
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "ListTransferRunsResponse"
},
"parameters": {
"parent": {
"pattern": "^projects/[^/]+/transferConfigs/[^/]+$",
"location": "path",
"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}`.",
"type": "string",
"required": true
},
"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.",
"type": "string",
"location": "query"
},
"pageSize": {
"format": "int32",
"description": "Page size. The default page size is the maximum value of 1000 results.",
"type": "integer",
"location": "query"
},
"states": {
"description": "When specified, only transfer runs with requested states are returned.",
"type": "string",
"repeated": true,
"location": "query",
"enum": [
"TRANSFER_STATE_UNSPECIFIED",
"INACTIVE",
"PENDING",
"RUNNING",
"SUCCEEDED",
"FAILED",
"CANCELLED"
]
},
"runAttempt": {
"location": "query",
"enum": [
"RUN_ATTEMPT_UNSPECIFIED",
"LATEST"
],
"description": "Indicates how run attempts are to be pulled.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs",
"path": "v1/{+parent}/runs",
"id": "bigquerydatatransfer.projects.transferConfigs.runs.list"
},
"get": {
"description": "Returns information about the particular transfer run.",
"response": {
"$ref": "TransferRun"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
"name": {
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
"id": "bigquerydatatransfer.projects.transferConfigs.runs.get",
"path": "v1/{+name}"
}
},
"resources": {
"transferLogs": {
"methods": {
"list": {
"description": "Returns user facing log messages for the data transfer run.",
"httpMethod": "GET",
"response": {
"$ref": "ListTransferLogsResponse"
},
"parameterOrder": [
"parent"
],
"parameters": {
"pageSize": {
"format": "int32",
"description": "Page size. The default page size is the maximum value of 1000 results.",
"type": "integer",
"location": "query"
},
"messageTypes": {
"repeated": true,
"location": "query",
"enum": [
"MESSAGE_SEVERITY_UNSPECIFIED",
"INFO",
"WARNING",
"ERROR"
],
"description": "Message types to return. If not populated - INFO, WARNING and ERROR\nmessages are returned.",
"type": "string"
},
"parent": {
"description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
"location": "path"
},
"pageToken": {
"location": "query",
"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.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1/projects/{projectsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs",
"path": "v1/{+parent}/transferLogs",
"id": "bigquerydatatransfer.projects.transferConfigs.runs.transferLogs.list"
}
}
}
}
}
}
},
"dataSources": {
"methods": {
"list": {
"description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
"response": {
"$ref": "ListDataSourcesResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
"pageSize": {
"format": "int32",
"description": "Page size. The default page size is the maximum value of 1000 results.",
"type": "integer",
"location": "query"
},
"parent": {
"location": "path",
"description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+$"
},
"pageToken": {
"location": "query",
"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.",
"type": "string"
}
},
"flatPath": "v1/projects/{projectsId}/dataSources",
"id": "bigquerydatatransfer.projects.dataSources.list",
"path": "v1/{+parent}/dataSources"
},
"get": {
"httpMethod": "GET",
"response": {
"$ref": "DataSource"
},
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"location": "path",
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/dataSources/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}",
"path": "v1/{+name}",
"id": "bigquerydatatransfer.projects.dataSources.get",
"description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering."
},
"checkValidCreds": {
"flatPath": "v1/projects/{projectsId}/dataSources/{dataSourcesId}:checkValidCreds",
"id": "bigquerydatatransfer.projects.dataSources.checkValidCreds",
"path": "v1/{+name}:checkValidCreds",
"request": {
"$ref": "CheckValidCredsRequest"
},
"description": "Returns true if valid credentials exist for the given data source and\nrequesting user.\nSome data sources doesn't support service account, so we need to talk to\nthem on behalf of the end user. This API just checks whether we have OAuth\ntoken for the particular user, which is a pre-requisite before user can\ncreate a transfer config.",
"response": {
"$ref": "CheckValidCredsResponse"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
"name": {
"description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/dataSources/[^/]+$",
"location": "path"
}
}
}
}
},
"locations": {
"methods": {
"get": {
"httpMethod": "GET",
"response": {
"$ref": "Location"
},
"parameterOrder": [
"name"
],
"parameters": {
"name": {
"location": "path",
"description": "Resource name for the location.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}",
"path": "v1/{+name}",
"id": "bigquerydatatransfer.projects.locations.get",
"description": "Get information about a location."
},
"list": {
"description": "Lists information about the supported locations for this service.",
"response": {
"$ref": "ListLocationsResponse"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"parameters": {
"filter": {
"type": "string",
"location": "query",
"description": "The standard list filter."
},
"pageToken": {
"location": "query",
"description": "The standard list page token.",
"type": "string"
},
"name": {
"location": "path",
"description": "The resource that owns the locations collection, if applicable.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+$"
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "The standard list page size.",
"type": "integer"
}
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1/projects/{projectsId}/locations",
"id": "bigquerydatatransfer.projects.locations.list",
"path": "v1/{+name}/locations"
}
},
"resources": {
"transferConfigs": {
"methods": {
"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.",
"request": {
"$ref": "ScheduleTransferRunsRequest"
},
"response": {
"$ref": "ScheduleTransferRunsResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"parameters": {
"parent": {
"location": "path",
"description": "Transfer configuration name in the form:\n`projects/{project_id}/transferConfigs/{config_id}`.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$"
}
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}:scheduleRuns",
"id": "bigquerydatatransfer.projects.locations.transferConfigs.scheduleRuns",
"path": "v1/{+parent}:scheduleRuns"
},
"get": {
"description": "Returns information about a data transfer config.",
"response": {
"$ref": "TransferConfig"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
"name": {
"location": "path",
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
"id": "bigquerydatatransfer.projects.locations.transferConfigs.get",
"path": "v1/{+name}"
},
"patch": {
"httpMethod": "PATCH",
"parameterOrder": [
"name"
],
"response": {
"$ref": "TransferConfig"
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"authorizationCode": {
"type": "string",
"location": "query",
"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=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\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."
},
"updateMask": {
"location": "query",
"format": "google-fieldmask",
"description": "Required list of fields to be updated in this request.",
"type": "string"
},
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
"location": "path",
"description": "The resource name of the transfer config.\nTransfer config 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\nconfig.",
"type": "string",
"required": true
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}",
"path": "v1/{+name}",
"id": "bigquerydatatransfer.projects.locations.transferConfigs.patch",
"request": {
"$ref": "TransferConfig"
},
"description": "Updates a data transfer configuration.\nAll fields must be set, even if they are not updated."
},
"delete": {
"id": "bigquerydatatransfer.projects.locations.transferConfigs.delete",
"path": "v1/{+name}",
"description": "Deletes a data transfer configuration,\nincluding any associated transfer runs and logs.",
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
"location": "path",
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}`",
"type": "string",
"required": true
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}"
},
"list": {
"response": {
"$ref": "ListTransferConfigsResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"parameters": {
"pageToken": {
"location": "query",
"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.",
"type": "string"
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "Page size. The default page size is the maximum value of 1000 results.",
"type": "integer"
},
"dataSourceIds": {
"description": "When specified, only configurations of requested data sources are returned.",
"type": "string",
"repeated": true,
"location": "query"
},
"parent": {
"description": "The BigQuery project id for which data sources\nshould be returned: `projects/{project_id}`.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs",
"id": "bigquerydatatransfer.projects.locations.transferConfigs.list",
"path": "v1/{+parent}/transferConfigs",
"description": "Returns information about all data transfers in the project."
},
"create": {
"description": "Creates a new data transfer configuration.",
"request": {
"$ref": "TransferConfig"
},
"response": {
"$ref": "TransferConfig"
},
"parameterOrder": [
"parent"
],
"httpMethod": "POST",
"parameters": {
"parent": {
"description": "The BigQuery project id where the transfer configuration should be created.\nMust be in the format /projects/{project_id}/locations/{location_id}\nor\n/projects/{project_id}/locations/-\nIn case when '-' is specified as location_id, location is infered from\nthe destination dataset region.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path"
},
"authorizationCode": {
"location": "query",
"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=\u003cdatatransferapiclientid\u003e&scope=\u003cdata_source_scopes\u003e&redirect_uri=\u003credirect_uri\u003e\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.",
"type": "string"
}
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs",
"id": "bigquerydatatransfer.projects.locations.transferConfigs.create",
"path": "v1/{+parent}/transferConfigs"
}
},
"resources": {
"runs": {
"methods": {
"delete": {
"response": {
"$ref": "Empty"
},
"parameterOrder": [
"name"
],
"httpMethod": "DELETE",
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform"
],
"parameters": {
"name": {
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
"location": "path",
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
"id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.delete",
"path": "v1/{+name}",
"description": "Deletes the specified transfer run."
},
"list": {
"description": "Returns information about running and completed jobs.",
"response": {
"$ref": "ListTransferRunsResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"parameters": {
"pageToken": {
"location": "query",
"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.",
"type": "string"
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "Page size. The default page size is the maximum value of 1000 results.",
"type": "integer"
},
"states": {
"location": "query",
"enum": [
"TRANSFER_STATE_UNSPECIFIED",
"INACTIVE",
"PENDING",
"RUNNING",
"SUCCEEDED",
"FAILED",
"CANCELLED"
],
"description": "When specified, only transfer runs with requested states are returned.",
"type": "string",
"repeated": true
},
"runAttempt": {
"description": "Indicates how run attempts are to be pulled.",
"type": "string",
"location": "query",
"enum": [
"RUN_ATTEMPT_UNSPECIFIED",
"LATEST"
]
},
"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}`.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs",
"id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.list",
"path": "v1/{+parent}/runs"
},
"get": {
"response": {
"$ref": "TransferRun"
},
"parameterOrder": [
"name"
],
"httpMethod": "GET",
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
"name": {
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
"location": "path",
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/transferConfigs/{config_id}/runs/{run_id}`"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}",
"id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.get",
"path": "v1/{+name}",
"description": "Returns information about the particular transfer run."
}
},
"resources": {
"transferLogs": {
"methods": {
"list": {
"response": {
"$ref": "ListTransferLogsResponse"
},
"parameterOrder": [
"parent"
],
"httpMethod": "GET",
"parameters": {
"pageToken": {
"location": "query",
"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.",
"type": "string"
},
"pageSize": {
"location": "query",
"format": "int32",
"description": "Page size. The default page size is the maximum value of 1000 results.",
"type": "integer"
},
"messageTypes": {
"description": "Message types to return. If not populated - INFO, WARNING and ERROR\nmessages are returned.",
"type": "string",
"repeated": true,
"location": "query",
"enum": [
"MESSAGE_SEVERITY_UNSPECIFIED",
"INFO",
"WARNING",
"ERROR"
]
},
"parent": {
"description": "Transfer run name in the form:\n`projects/{project_id}/transferConfigs/{config_Id}/runs/{run_id}`.",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/transferConfigs/[^/]+/runs/[^/]+$",
"location": "path"
}
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/transferConfigs/{transferConfigsId}/runs/{runsId}/transferLogs",
"id": "bigquerydatatransfer.projects.locations.transferConfigs.runs.transferLogs.list",
"path": "v1/{+parent}/transferLogs",
"description": "Returns user facing log messages for the data transfer run."
}
}
}
}
}
}
},
"dataSources": {
"methods": {
"list": {
"path": "v1/{+parent}/dataSources",
"id": "bigquerydatatransfer.projects.locations.dataSources.list",
"description": "Lists supported data sources and returns their settings,\nwhich can be used for UI rendering.",
"httpMethod": "GET",
"parameterOrder": [
"parent"
],
"response": {
"$ref": "ListDataSourcesResponse"
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"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.",
"type": "string",
"location": "query"
},
"pageSize": {
"format": "int32",
"description": "Page size. The default page size is the maximum value of 1000 results.",
"type": "integer",
"location": "query"
},
"parent": {
"description": "The BigQuery project id for which data sources should be returned.\nMust be in the form: `projects/{project_id}`",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+$",
"location": "path"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources"
},
"get": {
"description": "Retrieves a supported data source and returns its settings,\nwhich can be used for UI rendering.",
"httpMethod": "GET",
"parameterOrder": [
"name"
],
"response": {
"$ref": "DataSource"
},
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
"name": {
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$",
"location": "path",
"description": "The field will contain name of the resource requested, for example:\n`projects/{project_id}/dataSources/{data_source_id}`"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}",
"path": "v1/{+name}",
"id": "bigquerydatatransfer.projects.locations.dataSources.get"
},
"checkValidCreds": {
"request": {
"$ref": "CheckValidCredsRequest"
},
"description": "Returns true if valid credentials exist for the given data source and\nrequesting user.\nSome data sources doesn't support service account, so we need to talk to\nthem on behalf of the end user. This API just checks whether we have OAuth\ntoken for the particular user, which is a pre-requisite before user can\ncreate a transfer config.",
"response": {
"$ref": "CheckValidCredsResponse"
},
"parameterOrder": [
"name"
],
"httpMethod": "POST",
"scopes": [
"https://www.googleapis.com/auth/bigquery",
"https://www.googleapis.com/auth/cloud-platform",
"https://www.googleapis.com/auth/cloud-platform.read-only"
],
"parameters": {
"name": {
"location": "path",
"description": "The data source in the form:\n`projects/{project_id}/dataSources/{data_source_id}`",
"type": "string",
"required": true,
"pattern": "^projects/[^/]+/locations/[^/]+/dataSources/[^/]+$"
}
},
"flatPath": "v1/projects/{projectsId}/locations/{locationsId}/dataSources/{dataSourcesId}:checkValidCreds",
"id": "bigquerydatatransfer.projects.locations.dataSources.checkValidCreds",
"path": "v1/{+name}:checkValidCreds"
}
}
}
}
}
}
}
},
"parameters": {
"bearer_token": {
"location": "query",
"description": "OAuth bearer token.",
"type": "string"
},
"oauth_token": {
"description": "OAuth 2.0 token for the current user.",
"type": "string",
"location": "query"
},
"upload_protocol": {
"description": "Upload protocol for media (e.g. \"raw\", \"multipart\").",
"type": "string",
"location": "query"
},
"prettyPrint": {
"location": "query",
"description": "Returns response with indentations and line breaks.",
"default": "true",
"type": "boolean"
},
"fields": {
"location": "query",
"description": "Selector specifying which fields to include in a partial response.",
"type": "string"
},
"uploadType": {
"description": "Legacy upload protocol for media (e.g. \"media\", \"multipart\").",
"type": "string",
"location": "query"
},
"callback": {
"description": "JSONP",
"type": "string",
"location": "query"
},
"$.xgafv": {
"enumDescriptions": [
"v1 error format",
"v2 error format"
],
"location": "query",
"enum": [
"1",
"2"
],
"description": "V1 error format.",
"type": "string"
},
"alt": {
"enum": [
"json",
"media",
"proto"
],
"type": "string",
"enumDescriptions": [
"Responses with Content-Type of application/json",
"Media download with context-dependent Content-Type",
"Responses with Content-Type of application/x-protobuf"
],
"location": "query",
"description": "Data format for response.",
"default": "json"
},
"access_token": {
"location": "query",
"description": "OAuth access token.",
"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.",
"type": "string",
"location": "query"
},
"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.",
"type": "string",
"location": "query"
},
"pp": {
"location": "query",
"description": "Pretty-print response.",
"default": "true",
"type": "boolean"
}
},
"version": "v1",
"baseUrl": "https://bigquerydatatransfer.googleapis.com/",
"kind": "discovery#restDescription",
"description": "Transfers data from partner SaaS applications to Google BigQuery on a scheduled, managed basis.",
"servicePath": "",
"basePath": "",
"id": "bigquerydatatransfer:v1",
"documentationLink": "https://cloud.google.com/bigquery/",
"revision": "20170918",
"discoveryVersion": "v1"
}
View Git Blame Copy Permalink