| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, h1, h2, h3, div, span, p, pre, a { |
| 5 | margin: 0; |
| 6 | padding: 0; |
| 7 | border: 0; |
| 8 | font-weight: inherit; |
| 9 | font-style: inherit; |
| 10 | font-size: 100%; |
| 11 | font-family: inherit; |
| 12 | vertical-align: baseline; |
| 13 | } |
| 14 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, h2, h3 { |
| 50 | border-bottom: solid #CCC 1px; |
| 51 | } |
| 52 | |
| 53 | .toc_element { |
| 54 | margin-top: 0.5em; |
| 55 | } |
| 56 | |
| 57 | .firstline { |
| 58 | margin-left: 2 em; |
| 59 | } |
| 60 | |
| 61 | .method { |
| 62 | margin-top: 1em; |
| 63 | border: solid 1px #CCC; |
| 64 | padding: 1em; |
| 65 | background: #EEE; |
| 66 | } |
| 67 | |
| 68 | .details { |
| 69 | font-weight: bold; |
| 70 | font-size: 14px; |
| 71 | } |
| 72 | |
| 73 | </style> |
| 74 | |
| 75 | <h1><a href="bigquerydatatransfer_v1.html">BigQuery Data Transfer API</a> . <a href="bigquerydatatransfer_v1.projects.html">projects</a> . <a href="bigquerydatatransfer_v1.projects.locations.html">locations</a> . <a href="bigquerydatatransfer_v1.projects.locations.transferConfigs.html">transferConfigs</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| 78 | <code><a href="bigquerydatatransfer_v1.projects.locations.transferConfigs.runs.html">runs()</a></code> |
| 79 | </p> |
| 80 | <p class="firstline">Returns the runs Resource.</p> |
| 81 | |
| 82 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 83 | <code><a href="#create">create(parent, body=None, serviceAccountName=None, versionInfo=None, authorizationCode=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 84 | <p class="firstline">Creates a new data transfer configuration.</p> |
| 85 | <p class="toc_element"> |
| 86 | <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> |
| 87 | <p class="firstline">Deletes a data transfer configuration,</p> |
| 88 | <p class="toc_element"> |
| 89 | <code><a href="#get">get(name, x__xgafv=None)</a></code></p> |
| 90 | <p class="firstline">Returns information about a data transfer config.</p> |
| 91 | <p class="toc_element"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 92 | <code><a href="#list">list(parent, pageToken=None, pageSize=None, dataSourceIds=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 93 | <p class="firstline">Returns information about all data transfers in the project.</p> |
| 94 | <p class="toc_element"> |
| 95 | <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> |
| 96 | <p class="firstline">Retrieves the next page of results.</p> |
| 97 | <p class="toc_element"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 98 | <code><a href="#patch">patch(name, body=None, versionInfo=None, authorizationCode=None, updateMask=None, serviceAccountName=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 99 | <p class="firstline">Updates a data transfer configuration.</p> |
| 100 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 101 | <code><a href="#scheduleRuns">scheduleRuns(parent, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 102 | <p class="firstline">Creates transfer runs for a time range [start_time, end_time].</p> |
| 103 | <p class="toc_element"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 104 | <code><a href="#startManualRuns">startManualRuns(parent, body=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 105 | <p class="firstline">Start manual transfer runs to be executed now with schedule_time equal to</p> |
| 106 | <h3>Method Details</h3> |
| 107 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 108 | <code class="details" id="create">create(parent, body=None, serviceAccountName=None, versionInfo=None, authorizationCode=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 109 | <pre>Creates a new data transfer configuration. |
| 110 | |
| 111 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 112 | parent: string, Required. The BigQuery project id where the transfer configuration should be created. |
| 113 | Must be in the format projects/{project_id}/locations/{location_id} or |
| 114 | projects/{project_id}. If specified location and location of the |
| 115 | destination bigquery dataset do not match - the request will fail. (required) |
| 116 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 117 | The object takes the form of: |
| 118 | |
| 119 | { # Represents a data transfer configuration. A transfer configuration |
| 120 | # contains all metadata needed to perform a data transfer. For example, |
| 121 | # `destination_dataset_id` specifies where data should be stored. |
| 122 | # When a new transfer configuration is created, the specified |
| 123 | # `destination_dataset_id` is created when needed and shared with the |
| 124 | # appropriate data source service account. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 125 | "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. |
| 126 | # For example, if `data_refresh_window_days = 10`, then every day |
| 127 | # BigQuery reingests data for [today-10, today-1], rather than ingesting data |
| 128 | # for just [today-1]. |
| 129 | # Only valid if the data source supports the feature. Set the value to 0 |
| 130 | # to use the default value. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 131 | "scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule. |
| 132 | "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be |
| 133 | # scheduled at or after the end time. The end time can be changed at any |
| 134 | # moment. The time when a data transfer can be trigerred manually is not |
| 135 | # limited by this option. |
| 136 | "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be |
| 137 | # scheduled at or after the start time according to a recurrence pattern |
| 138 | # defined in the schedule string. The start time can be changed at any |
| 139 | # moment. The time when a data transfer can be trigerred manually is not |
| 140 | # limited by this option. |
| 141 | "disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration |
| 142 | # will be disabled. The runs can be started on ad-hoc basis using |
| 143 | # StartManualTransferRuns API. When automatic scheduling is disabled, the |
| 144 | # TransferConfig.schedule field will be ignored. |
| 145 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 146 | "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 147 | "state": "A String", # Output only. State of the most recently updated transfer run. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 148 | "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done. |
| 149 | "destinationDatasetId": "A String", # The BigQuery target dataset id. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 150 | "name": "A String", # The resource name of the transfer config. |
| 151 | # Transfer config names have the form of |
| 152 | # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. |
| 153 | # The name is automatically generated based on the config_id specified in |
| 154 | # CreateTransferConfigRequest along with project_id and region. If config_id |
| 155 | # is not provided, usually a uuid, even though it is not guaranteed or |
| 156 | # required, will be generated for config_id. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 157 | "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 158 | # associated with this transfer config finish. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 159 | "params": { # Data transfer specific parameters. |
| 160 | "a_key": "", # Properties of the object. |
| 161 | }, |
| 162 | "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences |
| 163 | # to the email address of the user who owns this transfer config. |
| 164 | # events. |
| 165 | "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures. |
| 166 | }, |
| 167 | "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located. |
| 168 | "displayName": "A String", # User specified display name for the data transfer. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 169 | "nextRunTime": "A String", # Output only. Next time when data transfer will run. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 170 | "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled |
| 171 | # for a given transfer. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 172 | "updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 173 | "schedule": "A String", # Data transfer schedule. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 174 | # If the data source does not support a custom schedule, this should be |
| 175 | # empty. If it is empty, the default value for the data source will be |
| 176 | # used. |
| 177 | # The specified times are in UTC. |
| 178 | # Examples of valid format: |
| 179 | # `1st,3rd monday of month 15:30`, |
| 180 | # `every wed,fri of jan,jun 13:15`, and |
| 181 | # `first sunday of quarter 00:00`. |
| 182 | # See more explanation about the format here: |
| 183 | # https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format |
| 184 | # NOTE: the granularity should be at least 8 hours, or less frequent. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 185 | } |
| 186 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 187 | serviceAccountName: string, Optional service account name. If this field is set, transfer config will |
| 188 | be created with this service account credentials. It requires that |
| 189 | requesting user calling this API has permissions to act as this service |
| 190 | account. |
| 191 | versionInfo: string, Optional version info. If users want to find a very recent access token, |
| 192 | that is, immediately after approving access, users have to set the |
| 193 | version_info claim in the token request. To obtain the version_info, users |
| 194 | must use the "none+gsession" response type. which be return a |
| 195 | version_info back in the authorization response which be be put in a JWT |
| 196 | claim in the token request. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 197 | authorizationCode: string, Optional OAuth2 authorization code to use with this transfer configuration. |
| 198 | This is required if new credentials are needed, as indicated by |
| 199 | `CheckValidCreds`. |
| 200 | In order to obtain authorization_code, please make a |
| 201 | request to |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 202 | https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 203 | |
| 204 | * client_id should be OAuth client_id of BigQuery DTS API for the given |
| 205 | data source returned by ListDataSources method. |
| 206 | * data_source_scopes are the scopes returned by ListDataSources method. |
| 207 | * redirect_uri is an optional parameter. If not specified, then |
| 208 | authorization code is posted to the opener of authorization flow window. |
| 209 | Otherwise it will be sent to the redirect uri. A special value of |
| 210 | urn:ietf:wg:oauth:2.0:oob means that authorization code should be |
| 211 | returned in the title bar of the browser, with the page text prompting |
| 212 | the user to copy the code and paste it in the application. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 213 | x__xgafv: string, V1 error format. |
| 214 | Allowed values |
| 215 | 1 - v1 error format |
| 216 | 2 - v2 error format |
| 217 | |
| 218 | Returns: |
| 219 | An object of the form: |
| 220 | |
| 221 | { # Represents a data transfer configuration. A transfer configuration |
| 222 | # contains all metadata needed to perform a data transfer. For example, |
| 223 | # `destination_dataset_id` specifies where data should be stored. |
| 224 | # When a new transfer configuration is created, the specified |
| 225 | # `destination_dataset_id` is created when needed and shared with the |
| 226 | # appropriate data source service account. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 227 | "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. |
| 228 | # For example, if `data_refresh_window_days = 10`, then every day |
| 229 | # BigQuery reingests data for [today-10, today-1], rather than ingesting data |
| 230 | # for just [today-1]. |
| 231 | # Only valid if the data source supports the feature. Set the value to 0 |
| 232 | # to use the default value. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 233 | "scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule. |
| 234 | "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be |
| 235 | # scheduled at or after the end time. The end time can be changed at any |
| 236 | # moment. The time when a data transfer can be trigerred manually is not |
| 237 | # limited by this option. |
| 238 | "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be |
| 239 | # scheduled at or after the start time according to a recurrence pattern |
| 240 | # defined in the schedule string. The start time can be changed at any |
| 241 | # moment. The time when a data transfer can be trigerred manually is not |
| 242 | # limited by this option. |
| 243 | "disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration |
| 244 | # will be disabled. The runs can be started on ad-hoc basis using |
| 245 | # StartManualTransferRuns API. When automatic scheduling is disabled, the |
| 246 | # TransferConfig.schedule field will be ignored. |
| 247 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 248 | "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 249 | "state": "A String", # Output only. State of the most recently updated transfer run. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 250 | "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done. |
| 251 | "destinationDatasetId": "A String", # The BigQuery target dataset id. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 252 | "name": "A String", # The resource name of the transfer config. |
| 253 | # Transfer config names have the form of |
| 254 | # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. |
| 255 | # The name is automatically generated based on the config_id specified in |
| 256 | # CreateTransferConfigRequest along with project_id and region. If config_id |
| 257 | # is not provided, usually a uuid, even though it is not guaranteed or |
| 258 | # required, will be generated for config_id. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 259 | "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 260 | # associated with this transfer config finish. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 261 | "params": { # Data transfer specific parameters. |
| 262 | "a_key": "", # Properties of the object. |
| 263 | }, |
| 264 | "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences |
| 265 | # to the email address of the user who owns this transfer config. |
| 266 | # events. |
| 267 | "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures. |
| 268 | }, |
| 269 | "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located. |
| 270 | "displayName": "A String", # User specified display name for the data transfer. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 271 | "nextRunTime": "A String", # Output only. Next time when data transfer will run. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 272 | "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled |
| 273 | # for a given transfer. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 274 | "updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 275 | "schedule": "A String", # Data transfer schedule. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 276 | # If the data source does not support a custom schedule, this should be |
| 277 | # empty. If it is empty, the default value for the data source will be |
| 278 | # used. |
| 279 | # The specified times are in UTC. |
| 280 | # Examples of valid format: |
| 281 | # `1st,3rd monday of month 15:30`, |
| 282 | # `every wed,fri of jan,jun 13:15`, and |
| 283 | # `first sunday of quarter 00:00`. |
| 284 | # See more explanation about the format here: |
| 285 | # https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format |
| 286 | # NOTE: the granularity should be at least 8 hours, or less frequent. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 287 | }</pre> |
| 288 | </div> |
| 289 | |
| 290 | <div class="method"> |
| 291 | <code class="details" id="delete">delete(name, x__xgafv=None)</code> |
| 292 | <pre>Deletes a data transfer configuration, |
| 293 | including any associated transfer runs and logs. |
| 294 | |
| 295 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 296 | name: string, Required. The field will contain name of the resource requested, for example: |
| 297 | `projects/{project_id}/transferConfigs/{config_id}` or |
| 298 | `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 299 | x__xgafv: string, V1 error format. |
| 300 | Allowed values |
| 301 | 1 - v1 error format |
| 302 | 2 - v2 error format |
| 303 | |
| 304 | Returns: |
| 305 | An object of the form: |
| 306 | |
| 307 | { # A generic empty message that you can re-use to avoid defining duplicated |
| 308 | # empty messages in your APIs. A typical example is to use it as the request |
| 309 | # or the response type of an API method. For instance: |
| 310 | # |
| 311 | # service Foo { |
| 312 | # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); |
| 313 | # } |
| 314 | # |
| 315 | # The JSON representation for `Empty` is empty JSON object `{}`. |
| 316 | }</pre> |
| 317 | </div> |
| 318 | |
| 319 | <div class="method"> |
| 320 | <code class="details" id="get">get(name, x__xgafv=None)</code> |
| 321 | <pre>Returns information about a data transfer config. |
| 322 | |
| 323 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 324 | name: string, Required. The field will contain name of the resource requested, for example: |
| 325 | `projects/{project_id}/transferConfigs/{config_id}` or |
| 326 | `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}` (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 327 | x__xgafv: string, V1 error format. |
| 328 | Allowed values |
| 329 | 1 - v1 error format |
| 330 | 2 - v2 error format |
| 331 | |
| 332 | Returns: |
| 333 | An object of the form: |
| 334 | |
| 335 | { # Represents a data transfer configuration. A transfer configuration |
| 336 | # contains all metadata needed to perform a data transfer. For example, |
| 337 | # `destination_dataset_id` specifies where data should be stored. |
| 338 | # When a new transfer configuration is created, the specified |
| 339 | # `destination_dataset_id` is created when needed and shared with the |
| 340 | # appropriate data source service account. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 341 | "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. |
| 342 | # For example, if `data_refresh_window_days = 10`, then every day |
| 343 | # BigQuery reingests data for [today-10, today-1], rather than ingesting data |
| 344 | # for just [today-1]. |
| 345 | # Only valid if the data source supports the feature. Set the value to 0 |
| 346 | # to use the default value. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 347 | "scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule. |
| 348 | "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be |
| 349 | # scheduled at or after the end time. The end time can be changed at any |
| 350 | # moment. The time when a data transfer can be trigerred manually is not |
| 351 | # limited by this option. |
| 352 | "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be |
| 353 | # scheduled at or after the start time according to a recurrence pattern |
| 354 | # defined in the schedule string. The start time can be changed at any |
| 355 | # moment. The time when a data transfer can be trigerred manually is not |
| 356 | # limited by this option. |
| 357 | "disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration |
| 358 | # will be disabled. The runs can be started on ad-hoc basis using |
| 359 | # StartManualTransferRuns API. When automatic scheduling is disabled, the |
| 360 | # TransferConfig.schedule field will be ignored. |
| 361 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 362 | "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 363 | "state": "A String", # Output only. State of the most recently updated transfer run. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 364 | "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done. |
| 365 | "destinationDatasetId": "A String", # The BigQuery target dataset id. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 366 | "name": "A String", # The resource name of the transfer config. |
| 367 | # Transfer config names have the form of |
| 368 | # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. |
| 369 | # The name is automatically generated based on the config_id specified in |
| 370 | # CreateTransferConfigRequest along with project_id and region. If config_id |
| 371 | # is not provided, usually a uuid, even though it is not guaranteed or |
| 372 | # required, will be generated for config_id. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 373 | "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 374 | # associated with this transfer config finish. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 375 | "params": { # Data transfer specific parameters. |
| 376 | "a_key": "", # Properties of the object. |
| 377 | }, |
| 378 | "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences |
| 379 | # to the email address of the user who owns this transfer config. |
| 380 | # events. |
| 381 | "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures. |
| 382 | }, |
| 383 | "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located. |
| 384 | "displayName": "A String", # User specified display name for the data transfer. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 385 | "nextRunTime": "A String", # Output only. Next time when data transfer will run. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 386 | "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled |
| 387 | # for a given transfer. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 388 | "updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 389 | "schedule": "A String", # Data transfer schedule. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 390 | # If the data source does not support a custom schedule, this should be |
| 391 | # empty. If it is empty, the default value for the data source will be |
| 392 | # used. |
| 393 | # The specified times are in UTC. |
| 394 | # Examples of valid format: |
| 395 | # `1st,3rd monday of month 15:30`, |
| 396 | # `every wed,fri of jan,jun 13:15`, and |
| 397 | # `first sunday of quarter 00:00`. |
| 398 | # See more explanation about the format here: |
| 399 | # https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format |
| 400 | # NOTE: the granularity should be at least 8 hours, or less frequent. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 401 | }</pre> |
| 402 | </div> |
| 403 | |
| 404 | <div class="method"> |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 405 | <code class="details" id="list">list(parent, pageToken=None, pageSize=None, dataSourceIds=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 406 | <pre>Returns information about all data transfers in the project. |
| 407 | |
| 408 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 409 | parent: string, Required. The BigQuery project id for which data sources |
| 410 | should be returned: `projects/{project_id}` or |
| 411 | `projects/{project_id}/locations/{location_id}` (required) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 412 | pageToken: string, Pagination token, which can be used to request a specific page |
| 413 | of `ListTransfersRequest` list results. For multiple-page |
| 414 | results, `ListTransfersResponse` outputs |
| 415 | a `next_page` token, which can be used as the |
| 416 | `page_token` value to request the next page of list results. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 417 | pageSize: integer, Page size. The default page size is the maximum value of 1000 results. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 418 | dataSourceIds: string, When specified, only configurations of requested data sources are returned. (repeated) |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 419 | x__xgafv: string, V1 error format. |
| 420 | Allowed values |
| 421 | 1 - v1 error format |
| 422 | 2 - v2 error format |
| 423 | |
| 424 | Returns: |
| 425 | An object of the form: |
| 426 | |
| 427 | { # The returned list of pipelines in the project. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 428 | "transferConfigs": [ # Output only. The stored pipeline transfer configurations. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 429 | { # Represents a data transfer configuration. A transfer configuration |
| 430 | # contains all metadata needed to perform a data transfer. For example, |
| 431 | # `destination_dataset_id` specifies where data should be stored. |
| 432 | # When a new transfer configuration is created, the specified |
| 433 | # `destination_dataset_id` is created when needed and shared with the |
| 434 | # appropriate data source service account. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 435 | "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. |
| 436 | # For example, if `data_refresh_window_days = 10`, then every day |
| 437 | # BigQuery reingests data for [today-10, today-1], rather than ingesting data |
| 438 | # for just [today-1]. |
| 439 | # Only valid if the data source supports the feature. Set the value to 0 |
| 440 | # to use the default value. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 441 | "scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule. |
| 442 | "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be |
| 443 | # scheduled at or after the end time. The end time can be changed at any |
| 444 | # moment. The time when a data transfer can be trigerred manually is not |
| 445 | # limited by this option. |
| 446 | "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be |
| 447 | # scheduled at or after the start time according to a recurrence pattern |
| 448 | # defined in the schedule string. The start time can be changed at any |
| 449 | # moment. The time when a data transfer can be trigerred manually is not |
| 450 | # limited by this option. |
| 451 | "disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration |
| 452 | # will be disabled. The runs can be started on ad-hoc basis using |
| 453 | # StartManualTransferRuns API. When automatic scheduling is disabled, the |
| 454 | # TransferConfig.schedule field will be ignored. |
| 455 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 456 | "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 457 | "state": "A String", # Output only. State of the most recently updated transfer run. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 458 | "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done. |
| 459 | "destinationDatasetId": "A String", # The BigQuery target dataset id. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 460 | "name": "A String", # The resource name of the transfer config. |
| 461 | # Transfer config names have the form of |
| 462 | # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. |
| 463 | # The name is automatically generated based on the config_id specified in |
| 464 | # CreateTransferConfigRequest along with project_id and region. If config_id |
| 465 | # is not provided, usually a uuid, even though it is not guaranteed or |
| 466 | # required, will be generated for config_id. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 467 | "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 468 | # associated with this transfer config finish. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 469 | "params": { # Data transfer specific parameters. |
| 470 | "a_key": "", # Properties of the object. |
| 471 | }, |
| 472 | "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences |
| 473 | # to the email address of the user who owns this transfer config. |
| 474 | # events. |
| 475 | "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures. |
| 476 | }, |
| 477 | "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located. |
| 478 | "displayName": "A String", # User specified display name for the data transfer. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 479 | "nextRunTime": "A String", # Output only. Next time when data transfer will run. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 480 | "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled |
| 481 | # for a given transfer. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 482 | "updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 483 | "schedule": "A String", # Data transfer schedule. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 484 | # If the data source does not support a custom schedule, this should be |
| 485 | # empty. If it is empty, the default value for the data source will be |
| 486 | # used. |
| 487 | # The specified times are in UTC. |
| 488 | # Examples of valid format: |
| 489 | # `1st,3rd monday of month 15:30`, |
| 490 | # `every wed,fri of jan,jun 13:15`, and |
| 491 | # `first sunday of quarter 00:00`. |
| 492 | # See more explanation about the format here: |
| 493 | # https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format |
| 494 | # NOTE: the granularity should be at least 8 hours, or less frequent. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 495 | }, |
| 496 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 497 | "nextPageToken": "A String", # Output only. The next-pagination token. For multiple-page list results, |
| 498 | # this token can be used as the |
| 499 | # `ListTransferConfigsRequest.page_token` |
| 500 | # to request the next page of list results. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 501 | }</pre> |
| 502 | </div> |
| 503 | |
| 504 | <div class="method"> |
| 505 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 506 | <pre>Retrieves the next page of results. |
| 507 | |
| 508 | Args: |
| 509 | previous_request: The request for the previous page. (required) |
| 510 | previous_response: The response from the request for the previous page. (required) |
| 511 | |
| 512 | Returns: |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 513 | A request object that you can call 'execute()' on to request the next |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 514 | page. Returns None if there are no more items in the collection. |
| 515 | </pre> |
| 516 | </div> |
| 517 | |
| 518 | <div class="method"> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 519 | <code class="details" id="patch">patch(name, body=None, versionInfo=None, authorizationCode=None, updateMask=None, serviceAccountName=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 520 | <pre>Updates a data transfer configuration. |
| 521 | All fields must be set, even if they are not updated. |
| 522 | |
| 523 | Args: |
| 524 | name: string, The resource name of the transfer config. |
| 525 | Transfer config names have the form of |
| 526 | `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. |
| 527 | The name is automatically generated based on the config_id specified in |
| 528 | CreateTransferConfigRequest along with project_id and region. If config_id |
| 529 | is not provided, usually a uuid, even though it is not guaranteed or |
| 530 | required, will be generated for config_id. (required) |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 531 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 532 | The object takes the form of: |
| 533 | |
| 534 | { # Represents a data transfer configuration. A transfer configuration |
| 535 | # contains all metadata needed to perform a data transfer. For example, |
| 536 | # `destination_dataset_id` specifies where data should be stored. |
| 537 | # When a new transfer configuration is created, the specified |
| 538 | # `destination_dataset_id` is created when needed and shared with the |
| 539 | # appropriate data source service account. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 540 | "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. |
| 541 | # For example, if `data_refresh_window_days = 10`, then every day |
| 542 | # BigQuery reingests data for [today-10, today-1], rather than ingesting data |
| 543 | # for just [today-1]. |
| 544 | # Only valid if the data source supports the feature. Set the value to 0 |
| 545 | # to use the default value. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 546 | "scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule. |
| 547 | "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be |
| 548 | # scheduled at or after the end time. The end time can be changed at any |
| 549 | # moment. The time when a data transfer can be trigerred manually is not |
| 550 | # limited by this option. |
| 551 | "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be |
| 552 | # scheduled at or after the start time according to a recurrence pattern |
| 553 | # defined in the schedule string. The start time can be changed at any |
| 554 | # moment. The time when a data transfer can be trigerred manually is not |
| 555 | # limited by this option. |
| 556 | "disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration |
| 557 | # will be disabled. The runs can be started on ad-hoc basis using |
| 558 | # StartManualTransferRuns API. When automatic scheduling is disabled, the |
| 559 | # TransferConfig.schedule field will be ignored. |
| 560 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 561 | "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 562 | "state": "A String", # Output only. State of the most recently updated transfer run. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 563 | "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done. |
| 564 | "destinationDatasetId": "A String", # The BigQuery target dataset id. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 565 | "name": "A String", # The resource name of the transfer config. |
| 566 | # Transfer config names have the form of |
| 567 | # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. |
| 568 | # The name is automatically generated based on the config_id specified in |
| 569 | # CreateTransferConfigRequest along with project_id and region. If config_id |
| 570 | # is not provided, usually a uuid, even though it is not guaranteed or |
| 571 | # required, will be generated for config_id. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 572 | "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 573 | # associated with this transfer config finish. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 574 | "params": { # Data transfer specific parameters. |
| 575 | "a_key": "", # Properties of the object. |
| 576 | }, |
| 577 | "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences |
| 578 | # to the email address of the user who owns this transfer config. |
| 579 | # events. |
| 580 | "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures. |
| 581 | }, |
| 582 | "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located. |
| 583 | "displayName": "A String", # User specified display name for the data transfer. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 584 | "nextRunTime": "A String", # Output only. Next time when data transfer will run. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 585 | "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled |
| 586 | # for a given transfer. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 587 | "updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 588 | "schedule": "A String", # Data transfer schedule. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 589 | # If the data source does not support a custom schedule, this should be |
| 590 | # empty. If it is empty, the default value for the data source will be |
| 591 | # used. |
| 592 | # The specified times are in UTC. |
| 593 | # Examples of valid format: |
| 594 | # `1st,3rd monday of month 15:30`, |
| 595 | # `every wed,fri of jan,jun 13:15`, and |
| 596 | # `first sunday of quarter 00:00`. |
| 597 | # See more explanation about the format here: |
| 598 | # https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format |
| 599 | # NOTE: the granularity should be at least 8 hours, or less frequent. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 600 | } |
| 601 | |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 602 | versionInfo: string, Optional version info. If users want to find a very recent access token, |
| 603 | that is, immediately after approving access, users have to set the |
| 604 | version_info claim in the token request. To obtain the version_info, users |
| 605 | must use the "none+gsession" response type. which be return a |
| 606 | version_info back in the authorization response which be be put in a JWT |
| 607 | claim in the token request. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 608 | authorizationCode: string, Optional OAuth2 authorization code to use with this transfer configuration. |
| 609 | If it is provided, the transfer configuration will be associated with the |
| 610 | authorizing user. |
| 611 | In order to obtain authorization_code, please make a |
| 612 | request to |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 613 | https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 614 | |
| 615 | * client_id should be OAuth client_id of BigQuery DTS API for the given |
| 616 | data source returned by ListDataSources method. |
| 617 | * data_source_scopes are the scopes returned by ListDataSources method. |
| 618 | * redirect_uri is an optional parameter. If not specified, then |
| 619 | authorization code is posted to the opener of authorization flow window. |
| 620 | Otherwise it will be sent to the redirect uri. A special value of |
| 621 | urn:ietf:wg:oauth:2.0:oob means that authorization code should be |
| 622 | returned in the title bar of the browser, with the page text prompting |
| 623 | the user to copy the code and paste it in the application. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 624 | updateMask: string, Required. Required list of fields to be updated in this request. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 625 | serviceAccountName: string, Optional service account name. If this field is set and |
| 626 | "service_account_name" is set in update_mask, transfer config will be |
| 627 | updated to use this service account credentials. It requires that |
| 628 | requesting user calling this API has permissions to act as this service |
| 629 | account. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 630 | x__xgafv: string, V1 error format. |
| 631 | Allowed values |
| 632 | 1 - v1 error format |
| 633 | 2 - v2 error format |
| 634 | |
| 635 | Returns: |
| 636 | An object of the form: |
| 637 | |
| 638 | { # Represents a data transfer configuration. A transfer configuration |
| 639 | # contains all metadata needed to perform a data transfer. For example, |
| 640 | # `destination_dataset_id` specifies where data should be stored. |
| 641 | # When a new transfer configuration is created, the specified |
| 642 | # `destination_dataset_id` is created when needed and shared with the |
| 643 | # appropriate data source service account. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 644 | "dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data. |
| 645 | # For example, if `data_refresh_window_days = 10`, then every day |
| 646 | # BigQuery reingests data for [today-10, today-1], rather than ingesting data |
| 647 | # for just [today-1]. |
| 648 | # Only valid if the data source supports the feature. Set the value to 0 |
| 649 | # to use the default value. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 650 | "scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule. |
| 651 | "endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be |
| 652 | # scheduled at or after the end time. The end time can be changed at any |
| 653 | # moment. The time when a data transfer can be trigerred manually is not |
| 654 | # limited by this option. |
| 655 | "startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be |
| 656 | # scheduled at or after the start time according to a recurrence pattern |
| 657 | # defined in the schedule string. The start time can be changed at any |
| 658 | # moment. The time when a data transfer can be trigerred manually is not |
| 659 | # limited by this option. |
| 660 | "disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration |
| 661 | # will be disabled. The runs can be started on ad-hoc basis using |
| 662 | # StartManualTransferRuns API. When automatic scheduling is disabled, the |
| 663 | # TransferConfig.schedule field will be ignored. |
| 664 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 665 | "dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 666 | "state": "A String", # Output only. State of the most recently updated transfer run. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 667 | "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done. |
| 668 | "destinationDatasetId": "A String", # The BigQuery target dataset id. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 669 | "name": "A String", # The resource name of the transfer config. |
| 670 | # Transfer config names have the form of |
| 671 | # `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`. |
| 672 | # The name is automatically generated based on the config_id specified in |
| 673 | # CreateTransferConfigRequest along with project_id and region. If config_id |
| 674 | # is not provided, usually a uuid, even though it is not guaranteed or |
| 675 | # required, will be generated for config_id. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 676 | "notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 677 | # associated with this transfer config finish. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 678 | "params": { # Data transfer specific parameters. |
| 679 | "a_key": "", # Properties of the object. |
| 680 | }, |
| 681 | "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences |
| 682 | # to the email address of the user who owns this transfer config. |
| 683 | # events. |
| 684 | "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures. |
| 685 | }, |
| 686 | "datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located. |
| 687 | "displayName": "A String", # User specified display name for the data transfer. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 688 | "nextRunTime": "A String", # Output only. Next time when data transfer will run. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 689 | "disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled |
| 690 | # for a given transfer. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 691 | "updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 692 | "schedule": "A String", # Data transfer schedule. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 693 | # If the data source does not support a custom schedule, this should be |
| 694 | # empty. If it is empty, the default value for the data source will be |
| 695 | # used. |
| 696 | # The specified times are in UTC. |
| 697 | # Examples of valid format: |
| 698 | # `1st,3rd monday of month 15:30`, |
| 699 | # `every wed,fri of jan,jun 13:15`, and |
| 700 | # `first sunday of quarter 00:00`. |
| 701 | # See more explanation about the format here: |
| 702 | # https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format |
| 703 | # NOTE: the granularity should be at least 8 hours, or less frequent. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 704 | }</pre> |
| 705 | </div> |
| 706 | |
| 707 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 708 | <code class="details" id="scheduleRuns">scheduleRuns(parent, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 709 | <pre>Creates transfer runs for a time range [start_time, end_time]. |
| 710 | For each date - or whatever granularity the data source supports - in the |
| 711 | range, one transfer run is created. |
| 712 | Note that runs are created per UTC time in the time range. |
| 713 | DEPRECATED: use StartManualTransferRuns instead. |
| 714 | |
| 715 | Args: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 716 | parent: string, Required. Transfer configuration name in the form: |
| 717 | `projects/{project_id}/transferConfigs/{config_id}` or |
| 718 | `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. (required) |
| 719 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 720 | The object takes the form of: |
| 721 | |
| 722 | { # A request to schedule transfer runs for a time range. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 723 | "startTime": "A String", # Required. Start time of the range of transfer runs. For example, |
| 724 | # `"2017-05-25T00:00:00+00:00"`. |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 725 | "endTime": "A String", # Required. End time of the range of transfer runs. For example, |
| 726 | # `"2017-05-30T00:00:00+00:00"`. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 727 | } |
| 728 | |
| 729 | x__xgafv: string, V1 error format. |
| 730 | Allowed values |
| 731 | 1 - v1 error format |
| 732 | 2 - v2 error format |
| 733 | |
| 734 | Returns: |
| 735 | An object of the form: |
| 736 | |
| 737 | { # A response to schedule transfer runs for a time range. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 738 | "runs": [ # The transfer runs that were scheduled. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 739 | { # Represents a data transfer run. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 740 | "dataSourceId": "A String", # Output only. Data source id. |
| 741 | "state": "A String", # Data transfer run state. Ignored for input requests. |
| 742 | "destinationDatasetId": "A String", # Output only. The BigQuery target dataset id. |
| 743 | "name": "A String", # The resource name of the transfer run. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 744 | # Transfer run names have the form |
| 745 | # `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. |
| 746 | # The name is ignored when creating a transfer run. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 747 | "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done. |
| 748 | "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 749 | # transfer run finishes |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 750 | "params": { # Output only. Data transfer specific parameters. |
| 751 | "a_key": "", # Properties of the object. |
| 752 | }, |
| 753 | "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Output only. Email notifications will be sent according to these |
| 754 | # preferences to the email address of the user who owns the transfer config |
| 755 | # this run was derived from. |
| 756 | # events. |
| 757 | "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures. |
| 758 | }, |
| 759 | "endTime": "A String", # Output only. Time when transfer run ended. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 760 | # Parameter ignored by server for input requests. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 761 | "startTime": "A String", # Output only. Time when transfer run was started. |
| 762 | # Parameter ignored by server for input requests. |
| 763 | "scheduleTime": "A String", # Minimum time after which a transfer run can be started. |
| 764 | "errorStatus": { # The `Status` type defines a logical error model that is suitable for # Status of the transfer run. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 765 | # different programming environments, including REST APIs and RPC APIs. It is |
| 766 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 767 | # three pieces of data: error code, error message, and error details. |
| 768 | # |
| 769 | # You can find out more about this error model and how to work with it in the |
| 770 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 771 | "details": [ # A list of messages that carry the error details. There is a common set of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 772 | # message types for APIs to use. |
| 773 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 774 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 775 | }, |
| 776 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 777 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 778 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 779 | # user-facing error message should be localized and sent in the |
| 780 | # google.rpc.Status.details field, or localized by the client. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 781 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 782 | "updateTime": "A String", # Output only. Last time the data transfer run state was updated. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 783 | "schedule": "A String", # Output only. Describes the schedule of this transfer run if it was |
| 784 | # created as part of a regular schedule. For batch transfer runs that are |
| 785 | # scheduled manually, this is empty. |
| 786 | # NOTE: the system might choose to delay the schedule depending on the |
| 787 | # current load, so `schedule_time` doesn't always match this. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 788 | "runTime": "A String", # For batch transfer runs, specifies the date and time of the data should be |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 789 | # ingested. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 790 | }, |
| 791 | ], |
| 792 | }</pre> |
| 793 | </div> |
| 794 | |
| 795 | <div class="method"> |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 796 | <code class="details" id="startManualRuns">startManualRuns(parent, body=None, x__xgafv=None)</code> |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 797 | <pre>Start manual transfer runs to be executed now with schedule_time equal to |
| 798 | current time. The transfer runs can be created for a time range where the |
| 799 | run_time is between start_time (inclusive) and end_time (exclusive), or for |
| 800 | a specific run_time. |
| 801 | |
| 802 | Args: |
| 803 | parent: string, Transfer configuration name in the form: |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 804 | `projects/{project_id}/transferConfigs/{config_id}` or |
| 805 | `projects/{project_id}/locations/{location_id}/transferConfigs/{config_id}`. (required) |
| 806 | body: object, The request body. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 807 | The object takes the form of: |
| 808 | |
| 809 | { # A request to start manual transfer runs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 810 | "requestedTimeRange": { # A specification for a time range, this will request transfer runs with # Time range for the transfer runs that should be started. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 811 | # run_time between start_time (inclusive) and end_time (exclusive). |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame] | 812 | "startTime": "A String", # Start time of the range of transfer runs. For example, |
| 813 | # `"2017-05-25T00:00:00+00:00"`. The start_time must be strictly less than |
| 814 | # the end_time. Creates transfer runs where run_time is in the range betwen |
| 815 | # start_time (inclusive) and end_time (exlusive). |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 816 | "endTime": "A String", # End time of the range of transfer runs. For example, |
| 817 | # `"2017-05-30T00:00:00+00:00"`. The end_time must not be in the future. |
| 818 | # Creates transfer runs where run_time is in the range betwen start_time |
| 819 | # (inclusive) and end_time (exlusive). |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 820 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 821 | "requestedRunTime": "A String", # Specific run_time for a transfer run to be started. The |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 822 | # requested_run_time must not be in the future. |
| 823 | } |
| 824 | |
| 825 | x__xgafv: string, V1 error format. |
| 826 | Allowed values |
| 827 | 1 - v1 error format |
| 828 | 2 - v2 error format |
| 829 | |
| 830 | Returns: |
| 831 | An object of the form: |
| 832 | |
| 833 | { # A response to start manual transfer runs. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 834 | "runs": [ # The transfer runs that were created. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 835 | { # Represents a data transfer run. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 836 | "dataSourceId": "A String", # Output only. Data source id. |
| 837 | "state": "A String", # Data transfer run state. Ignored for input requests. |
| 838 | "destinationDatasetId": "A String", # Output only. The BigQuery target dataset id. |
| 839 | "name": "A String", # The resource name of the transfer run. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 840 | # Transfer run names have the form |
| 841 | # `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`. |
| 842 | # The name is ignored when creating a transfer run. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 843 | "userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done. |
| 844 | "notificationPubsubTopic": "A String", # Output only. Pub/Sub topic where a notification will be sent after this |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 845 | # transfer run finishes |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 846 | "params": { # Output only. Data transfer specific parameters. |
| 847 | "a_key": "", # Properties of the object. |
| 848 | }, |
| 849 | "emailPreferences": { # Represents preferences for sending email notifications for transfer run # Output only. Email notifications will be sent according to these |
| 850 | # preferences to the email address of the user who owns the transfer config |
| 851 | # this run was derived from. |
| 852 | # events. |
| 853 | "enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures. |
| 854 | }, |
| 855 | "endTime": "A String", # Output only. Time when transfer run ended. |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 856 | # Parameter ignored by server for input requests. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 857 | "startTime": "A String", # Output only. Time when transfer run was started. |
| 858 | # Parameter ignored by server for input requests. |
| 859 | "scheduleTime": "A String", # Minimum time after which a transfer run can be started. |
| 860 | "errorStatus": { # The `Status` type defines a logical error model that is suitable for # Status of the transfer run. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 861 | # different programming environments, including REST APIs and RPC APIs. It is |
| 862 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 863 | # three pieces of data: error code, error message, and error details. |
| 864 | # |
| 865 | # You can find out more about this error model and how to work with it in the |
| 866 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 867 | "details": [ # A list of messages that carry the error details. There is a common set of |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 868 | # message types for APIs to use. |
| 869 | { |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 870 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 871 | }, |
| 872 | ], |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 873 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 874 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 875 | # user-facing error message should be localized and sent in the |
| 876 | # google.rpc.Status.details field, or localized by the client. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 877 | }, |
| Bu Sun Kim | d059ad8 | 2020-07-22 17:02:09 -0700 | [diff] [blame^] | 878 | "updateTime": "A String", # Output only. Last time the data transfer run state was updated. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 879 | "schedule": "A String", # Output only. Describes the schedule of this transfer run if it was |
| 880 | # created as part of a regular schedule. For batch transfer runs that are |
| 881 | # scheduled manually, this is empty. |
| 882 | # NOTE: the system might choose to delay the schedule depending on the |
| 883 | # current load, so `schedule_time` doesn't always match this. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 884 | "runTime": "A String", # For batch transfer runs, specifies the date and time of the data should be |
| Dan O'Meara | dd49464 | 2020-05-01 07:42:23 -0700 | [diff] [blame] | 885 | # ingested. |
| Bu Sun Kim | 715bd7f | 2019-06-14 16:50:42 -0700 | [diff] [blame] | 886 | }, |
| 887 | ], |
| 888 | }</pre> |
| 889 | </div> |
| 890 | |
| 891 | </body></html> |