Blame - docs/dyn/bigquerydatatransfer_v1.projects.transferConfigs.html - platform/external/python/google-api-python-client

2017-06-06 18:46:08 -0400

[diff] [blame]

76

<h2>Instance Methods</h2>

</p>

<p class="firstline">Returns the runs Resource.</p>

81

82

Bu Sun Kim

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>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

84

<p class="firstline">Creates a new data transfer configuration.</p>

85

86

<code><a href="#delete">delete(name, x__xgafv=None)</a></code></p>

87

<p class="firstline">Deletes a data transfer configuration,</p>

88

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

92

<code><a href="#list">list(parent, pageToken=None, pageSize=None, dataSourceIds=None, x__xgafv=None)</a></code></p>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

93

<p class="firstline">Returns information about all data transfers in the project.</p>

94

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

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

98

<code><a href="#patch">patch(name, body=None, updateMask=None, serviceAccountName=None, versionInfo=None, authorizationCode=None, x__xgafv=None)</a></code></p>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

99

<p class="firstline">Updates a data transfer configuration.</p>

100

Dan O'Meara

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

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

Dan O'Meara

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

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>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

106

<h3>Method Details</h3>

107

Bu Sun Kim

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>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

109

<pre>Creates a new data transfer configuration.

110

111

Args:

Dan O'Meara

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.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[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

2020-05-20 12:08:20 -0700

[diff] [blame^]

125

"notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

126

# associated with this transfer config finish.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

127

"params": { # Data transfer specific parameters.

128

"a_key": "", # Properties of the object.

129

},

130

"emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences

131

# to the email address of the user who owns this transfer config.

132

# events.

133

"enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.

134

},

135

"datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.

136

"displayName": "A String", # User specified display name for the data transfer.

137

"disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled

138

# for a given transfer.

139

"nextRunTime": "A String", # Output only. Next time when data transfer will run.

140

"schedule": "A String", # Data transfer schedule.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

141

# If the data source does not support a custom schedule, this should be

142

# empty. If it is empty, the default value for the data source will be

143

# used.

144

# The specified times are in UTC.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

145

# Examples of valid format:

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

146

# `1st,3rd monday of month 15:30`,

147

# `every wed,fri of jan,jun 13:15`, and

148

# `first sunday of quarter 00:00`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

149

# See more explanation about the format here:

150

# https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format

151

# NOTE: the granularity should be at least 8 hours, or less frequent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

152

"updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.

153

"dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

154

# For example, if `data_refresh_window_days = 10`, then every day

155

# BigQuery reingests data for [today-10, today-1], rather than ingesting data

156

# for just [today-1].

157

# Only valid if the data source supports the feature. Set the value to 0

158

# to use the default value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

159

"dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.

160

"scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.

161

"disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration

162

# will be disabled. The runs can be started on ad-hoc basis using

163

# StartManualTransferRuns API. When automatic scheduling is disabled, the

164

# TransferConfig.schedule field will be ignored.

165

"endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be

166

# scheduled at or after the end time. The end time can be changed at any

167

# moment. The time when a data transfer can be trigerred manually is not

168

# limited by this option.

169

"startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be

170

# scheduled at or after the start time according to a recurrence pattern

171

# defined in the schedule string. The start time can be changed at any

172

# moment. The time when a data transfer can be trigerred manually is not

173

# limited by this option.

174

},

175

"state": "A String", # Output only. State of the most recently updated transfer run.

176

"name": "A String", # The resource name of the transfer config.

177

# Transfer config names have the form of

178

# `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.

179

# The name is automatically generated based on the config_id specified in

180

# CreateTransferConfigRequest along with project_id and region. If config_id

181

# is not provided, usually a uuid, even though it is not guaranteed or

182

# required, will be generated for config_id.

183

"destinationDatasetId": "A String", # The BigQuery target dataset id.

184

"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

185

}

186

Bu Sun Kim

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.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[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

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>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

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

213

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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

2020-05-20 12:08:20 -0700

[diff] [blame^]

227

"notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

228

# associated with this transfer config finish.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

229

"params": { # Data transfer specific parameters.

230

"a_key": "", # Properties of the object.

231

},

232

"emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences

233

# to the email address of the user who owns this transfer config.

234

# events.

235

"enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.

236

},

237

"datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.

238

"displayName": "A String", # User specified display name for the data transfer.

239

"disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled

240

# for a given transfer.

241

"nextRunTime": "A String", # Output only. Next time when data transfer will run.

242

"schedule": "A String", # Data transfer schedule.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

243

# If the data source does not support a custom schedule, this should be

244

# empty. If it is empty, the default value for the data source will be

245

# used.

246

# The specified times are in UTC.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

247

# Examples of valid format:

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

248

# `1st,3rd monday of month 15:30`,

249

# `every wed,fri of jan,jun 13:15`, and

250

# `first sunday of quarter 00:00`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

251

# See more explanation about the format here:

252

# https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format

253

# NOTE: the granularity should be at least 8 hours, or less frequent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

254

"updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.

255

"dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

256

# For example, if `data_refresh_window_days = 10`, then every day

257

# BigQuery reingests data for [today-10, today-1], rather than ingesting data

258

# for just [today-1].

259

# Only valid if the data source supports the feature. Set the value to 0

260

# to use the default value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

261

"dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.

262

"scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.

263

"disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration

264

# will be disabled. The runs can be started on ad-hoc basis using

265

# StartManualTransferRuns API. When automatic scheduling is disabled, the

266

# TransferConfig.schedule field will be ignored.

267

"endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be

268

# scheduled at or after the end time. The end time can be changed at any

269

# moment. The time when a data transfer can be trigerred manually is not

270

# limited by this option.

271

"startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be

272

# scheduled at or after the start time according to a recurrence pattern

273

# defined in the schedule string. The start time can be changed at any

274

# moment. The time when a data transfer can be trigerred manually is not

275

# limited by this option.

276

},

277

"state": "A String", # Output only. State of the most recently updated transfer run.

278

"name": "A String", # The resource name of the transfer config.

279

# Transfer config names have the form of

280

# `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.

281

# The name is automatically generated based on the config_id specified in

282

# CreateTransferConfigRequest along with project_id and region. If config_id

283

# is not provided, usually a uuid, even though it is not guaranteed or

284

# required, will be generated for config_id.

285

"destinationDatasetId": "A String", # The BigQuery target dataset id.

286

"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

}</pre>

</div>

<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

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)

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

299

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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 `{}`.

}</pre>

</div>

<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

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)

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

327

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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

2020-05-20 12:08:20 -0700

[diff] [blame^]

341

"notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

342

# associated with this transfer config finish.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

343

"params": { # Data transfer specific parameters.

344

"a_key": "", # Properties of the object.

345

},

346

"emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences

347

# to the email address of the user who owns this transfer config.

348

# events.

349

"enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.

350

},

351

"datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.

352

"displayName": "A String", # User specified display name for the data transfer.

353

"disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled

354

# for a given transfer.

355

"nextRunTime": "A String", # Output only. Next time when data transfer will run.

356

"schedule": "A String", # Data transfer schedule.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

357

# If the data source does not support a custom schedule, this should be

358

# empty. If it is empty, the default value for the data source will be

359

# used.

360

# The specified times are in UTC.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

361

# Examples of valid format:

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

362

# `1st,3rd monday of month 15:30`,

363

# `every wed,fri of jan,jun 13:15`, and

364

# `first sunday of quarter 00:00`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

365

# See more explanation about the format here:

366

# https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format

367

# NOTE: the granularity should be at least 8 hours, or less frequent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

368

"updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.

369

"dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

370

# For example, if `data_refresh_window_days = 10`, then every day

371

# BigQuery reingests data for [today-10, today-1], rather than ingesting data

372

# for just [today-1].

373

# Only valid if the data source supports the feature. Set the value to 0

374

# to use the default value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

375

"dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.

376

"scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.

377

"disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration

378

# will be disabled. The runs can be started on ad-hoc basis using

379

# StartManualTransferRuns API. When automatic scheduling is disabled, the

380

# TransferConfig.schedule field will be ignored.

381

"endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be

382

# scheduled at or after the end time. The end time can be changed at any

383

# moment. The time when a data transfer can be trigerred manually is not

384

# limited by this option.

385

"startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be

386

# scheduled at or after the start time according to a recurrence pattern

387

# defined in the schedule string. The start time can be changed at any

388

# moment. The time when a data transfer can be trigerred manually is not

389

# limited by this option.

390

},

391

"state": "A String", # Output only. State of the most recently updated transfer run.

392

"name": "A String", # The resource name of the transfer config.

393

# Transfer config names have the form of

394

# `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.

395

# The name is automatically generated based on the config_id specified in

396

# CreateTransferConfigRequest along with project_id and region. If config_id

397

# is not provided, usually a uuid, even though it is not guaranteed or

398

# required, will be generated for config_id.

399

"destinationDatasetId": "A String", # The BigQuery target dataset id.

400

"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

}</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

405

<code class="details" id="list">list(parent, pageToken=None, pageSize=None, dataSourceIds=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

406

<pre>Returns information about all data transfers in the project.

407

408

Args:

Dan O'Meara

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)

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[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

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.

418

dataSourceIds: string, When specified, only configurations of requested data sources are returned. (repeated)

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

419

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

426

427

{ # The returned list of pipelines in the project.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

428

"nextPageToken": "A String", # Output only. The next-pagination token. For multiple-page list results,

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

429

# this token can be used as the

430

# `ListTransferConfigsRequest.page_token`

431

# to request the next page of list results.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

432

"transferConfigs": [ # Output only. The stored pipeline transfer configurations.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

433

{ # Represents a data transfer configuration. A transfer configuration

434

# contains all metadata needed to perform a data transfer. For example,

435

# `destination_dataset_id` specifies where data should be stored.

436

# When a new transfer configuration is created, the specified

437

# `destination_dataset_id` is created when needed and shared with the

438

# appropriate data source service account.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

439

"notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

440

# associated with this transfer config finish.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

441

"params": { # Data transfer specific parameters.

442

"a_key": "", # Properties of the object.

443

},

444

"emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences

445

# to the email address of the user who owns this transfer config.

446

# events.

447

"enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.

448

},

449

"datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.

450

"displayName": "A String", # User specified display name for the data transfer.

451

"disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled

452

# for a given transfer.

453

"nextRunTime": "A String", # Output only. Next time when data transfer will run.

454

"schedule": "A String", # Data transfer schedule.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

455

# If the data source does not support a custom schedule, this should be

456

# empty. If it is empty, the default value for the data source will be

457

# used.

458

# The specified times are in UTC.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

459

# Examples of valid format:

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

460

# `1st,3rd monday of month 15:30`,

461

# `every wed,fri of jan,jun 13:15`, and

462

# `first sunday of quarter 00:00`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

463

# See more explanation about the format here:

464

# https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format

465

# NOTE: the granularity should be at least 8 hours, or less frequent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

466

"updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.

467

"dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

468

# For example, if `data_refresh_window_days = 10`, then every day

469

# BigQuery reingests data for [today-10, today-1], rather than ingesting data

470

# for just [today-1].

471

# Only valid if the data source supports the feature. Set the value to 0

472

# to use the default value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

473

"dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.

474

"scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.

475

"disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration

476

# will be disabled. The runs can be started on ad-hoc basis using

477

# StartManualTransferRuns API. When automatic scheduling is disabled, the

478

# TransferConfig.schedule field will be ignored.

479

"endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be

480

# scheduled at or after the end time. The end time can be changed at any

481

# moment. The time when a data transfer can be trigerred manually is not

482

# limited by this option.

483

"startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be

484

# scheduled at or after the start time according to a recurrence pattern

485

# defined in the schedule string. The start time can be changed at any

486

# moment. The time when a data transfer can be trigerred manually is not

487

# limited by this option.

488

},

489

"state": "A String", # Output only. State of the most recently updated transfer run.

490

"name": "A String", # The resource name of the transfer config.

491

# Transfer config names have the form of

492

# `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.

493

# The name is automatically generated based on the config_id specified in

494

# CreateTransferConfigRequest along with project_id and region. If config_id

495

# is not provided, usually a uuid, even though it is not guaranteed or

496

# required, will be generated for config_id.

497

"destinationDatasetId": "A String", # The BigQuery target dataset id.

498

"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

},

],

}</pre>

</div>

<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

2020-05-20 12:08:20 -0700

[diff] [blame^]

513

A request object that you can call 'execute()' on to request the next

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

514

page. Returns None if there are no more items in the collection.

</pre>

</div>

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

519

<code class="details" id="patch">patch(name, body=None, updateMask=None, serviceAccountName=None, versionInfo=None, authorizationCode=None, x__xgafv=None)</code>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

520

<pre>Updates a data transfer configuration.

521

All fields must be set, even if they are not updated.

522

523

Args:

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

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

2020-05-01 07:42:23 -0700

[diff] [blame]

531

body: object, The request body.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[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

2020-05-20 12:08:20 -0700

[diff] [blame^]

540

"notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

541

# associated with this transfer config finish.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

542

"params": { # Data transfer specific parameters.

543

"a_key": "", # Properties of the object.

544

},

545

"emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences

546

# to the email address of the user who owns this transfer config.

547

# events.

548

"enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.

549

},

550

"datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.

551

"displayName": "A String", # User specified display name for the data transfer.

552

"disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled

553

# for a given transfer.

554

"nextRunTime": "A String", # Output only. Next time when data transfer will run.

555

"schedule": "A String", # Data transfer schedule.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

556

# If the data source does not support a custom schedule, this should be

557

# empty. If it is empty, the default value for the data source will be

558

# used.

559

# The specified times are in UTC.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

560

# Examples of valid format:

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

561

# `1st,3rd monday of month 15:30`,

562

# `every wed,fri of jan,jun 13:15`, and

563

# `first sunday of quarter 00:00`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

564

# See more explanation about the format here:

565

# https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format

566

# NOTE: the granularity should be at least 8 hours, or less frequent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

567

"updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.

568

"dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

569

# For example, if `data_refresh_window_days = 10`, then every day

570

# BigQuery reingests data for [today-10, today-1], rather than ingesting data

571

# for just [today-1].

572

# Only valid if the data source supports the feature. Set the value to 0

573

# to use the default value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

574

"dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.

575

"scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.

576

"disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration

577

# will be disabled. The runs can be started on ad-hoc basis using

578

# StartManualTransferRuns API. When automatic scheduling is disabled, the

579

# TransferConfig.schedule field will be ignored.

580

"endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be

581

# scheduled at or after the end time. The end time can be changed at any

582

# moment. The time when a data transfer can be trigerred manually is not

583

# limited by this option.

584

"startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be

585

# scheduled at or after the start time according to a recurrence pattern

586

# defined in the schedule string. The start time can be changed at any

587

# moment. The time when a data transfer can be trigerred manually is not

588

# limited by this option.

589

},

590

"state": "A String", # Output only. State of the most recently updated transfer run.

591

"name": "A String", # The resource name of the transfer config.

592

# Transfer config names have the form of

593

# `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.

594

# The name is automatically generated based on the config_id specified in

595

# CreateTransferConfigRequest along with project_id and region. If config_id

596

# is not provided, usually a uuid, even though it is not guaranteed or

597

# required, will be generated for config_id.

598

"destinationDatasetId": "A String", # The BigQuery target dataset id.

599

"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

600

}

601

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

602

updateMask: string, Required. Required list of fields to be updated in this request.

603

serviceAccountName: string, Optional service account name. If this field is set and

604

"service_account_name" is set in update_mask, transfer config will be

605

updated to use this service account credentials. It requires that

606

requesting user calling this API has permissions to act as this service

607

account.

608

versionInfo: string, Optional version info. If users want to find a very recent access token,

609

that is, immediately after approving access, users have to set the

610

version_info claim in the token request. To obtain the version_info, users

611

must use the "none+gsession" response type. which be return a

612

version_info back in the authorization response which be be put in a JWT

613

claim in the token request.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

614

authorizationCode: string, Optional OAuth2 authorization code to use with this transfer configuration.

615

If it is provided, the transfer configuration will be associated with the

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

616

authorizing user.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

617

In order to obtain authorization_code, please make a

618

request to

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

619

https://www.gstatic.com/bigquerydatatransfer/oauthz/auth?client_id=<datatransferapiclientid>&scope=<data_source_scopes>&redirect_uri=<redirect_uri>

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

620

621

* client_id should be OAuth client_id of BigQuery DTS API for the given

622

data source returned by ListDataSources method.

623

* data_source_scopes are the scopes returned by ListDataSources method.

624

* redirect_uri is an optional parameter. If not specified, then

625

authorization code is posted to the opener of authorization flow window.

626

Otherwise it will be sent to the redirect uri. A special value of

627

urn:ietf:wg:oauth:2.0:oob means that authorization code should be

628

returned in the title bar of the browser, with the page text prompting

629

the user to copy the code and paste it in the application.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

630

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

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

2020-05-20 12:08:20 -0700

[diff] [blame^]

644

"notificationPubsubTopic": "A String", # Pub/Sub topic where notifications will be sent after transfer runs

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

645

# associated with this transfer config finish.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

646

"params": { # Data transfer specific parameters.

647

"a_key": "", # Properties of the object.

648

},

649

"emailPreferences": { # Represents preferences for sending email notifications for transfer run # Email notifications will be sent according to these preferences

650

# to the email address of the user who owns this transfer config.

651

# events.

652

"enableFailureEmail": True or False, # If true, email notifications will be sent on transfer run failures.

653

},

654

"datasetRegion": "A String", # Output only. Region in which BigQuery dataset is located.

655

"displayName": "A String", # User specified display name for the data transfer.

656

"disabled": True or False, # Is this config disabled. When set to true, no runs are scheduled

657

# for a given transfer.

658

"nextRunTime": "A String", # Output only. Next time when data transfer will run.

659

"schedule": "A String", # Data transfer schedule.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

660

# If the data source does not support a custom schedule, this should be

661

# empty. If it is empty, the default value for the data source will be

662

# used.

663

# The specified times are in UTC.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

664

# Examples of valid format:

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

665

# `1st,3rd monday of month 15:30`,

666

# `every wed,fri of jan,jun 13:15`, and

667

# `first sunday of quarter 00:00`.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

668

# See more explanation about the format here:

669

# https://cloud.google.com/appengine/docs/flexible/python/scheduling-jobs-with-cron-yaml#the_schedule_format

670

# NOTE: the granularity should be at least 8 hours, or less frequent.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

671

"updateTime": "A String", # Output only. Data transfer modification time. Ignored by server on input.

672

"dataRefreshWindowDays": 42, # The number of days to look back to automatically refresh the data.

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

673

# For example, if `data_refresh_window_days = 10`, then every day

674

# BigQuery reingests data for [today-10, today-1], rather than ingesting data

675

# for just [today-1].

676

# Only valid if the data source supports the feature. Set the value to 0

677

# to use the default value.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

678

"dataSourceId": "A String", # Data source id. Cannot be changed once data transfer is created.

679

"scheduleOptions": { # Options customizing the data transfer schedule. # Options customizing the data transfer schedule.

680

"disableAutoScheduling": True or False, # If true, automatic scheduling of data transfer runs for this configuration

681

# will be disabled. The runs can be started on ad-hoc basis using

682

# StartManualTransferRuns API. When automatic scheduling is disabled, the

683

# TransferConfig.schedule field will be ignored.

684

"endTime": "A String", # Defines time to stop scheduling transfer runs. A transfer run cannot be

685

# scheduled at or after the end time. The end time can be changed at any

686

# moment. The time when a data transfer can be trigerred manually is not

687

# limited by this option.

688

"startTime": "A String", # Specifies time to start scheduling transfer runs. The first run will be

689

# scheduled at or after the start time according to a recurrence pattern

690

# defined in the schedule string. The start time can be changed at any

691

# moment. The time when a data transfer can be trigerred manually is not

692

# limited by this option.

693

},

694

"state": "A String", # Output only. State of the most recently updated transfer run.

695

"name": "A String", # The resource name of the transfer config.

696

# Transfer config names have the form of

697

# `projects/{project_id}/locations/{region}/transferConfigs/{config_id}`.

698

# The name is automatically generated based on the config_id specified in

699

# CreateTransferConfigRequest along with project_id and region. If config_id

700

# is not provided, usually a uuid, even though it is not guaranteed or

701

# required, will be generated for config_id.

702

"destinationDatasetId": "A String", # The BigQuery target dataset id.

703

"userId": "A String", # Deprecated. Unique ID of the user on whose behalf transfer is done.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

}</pre>

</div>

Dan O'Meara

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

2019-06-14 16:50:42 -0700

[diff] [blame]

709

<pre>Creates transfer runs for a time range [start_time, end_time].

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

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.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

713

DEPRECATED: use StartManualTransferRuns instead.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

714

715

Args:

Dan O'Meara

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.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

720

The object takes the form of:

721

722

{ # A request to schedule transfer runs for a time range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

723

"endTime": "A String", # Required. End time of the range of transfer runs. For example,

724

# `"2017-05-30T00:00:00+00:00"`.

725

"startTime": "A String", # Required. Start time of the range of transfer runs. For example,

726

# `"2017-05-25T00:00:00+00:00"`.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

727

}

728

729

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

736

737

{ # A response to schedule transfer runs for a time range.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

738

"runs": [ # The transfer runs that were scheduled.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

739

{ # Represents a data transfer run.

Bu Sun Kim

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.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

744

# Transfer run names have the form

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

745

# `projects/{project_id}/locations/{location}/transferConfigs/{config_id}/runs/{run_id}`.

Sai Cheemalapati

2017-06-06 18:46:08 -0400

[diff] [blame]

746

# The name is ignored when creating a transfer run.

Bu Sun Kim

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

2020-05-01 07:42:23 -0700

[diff] [blame]

749

# transfer run finishes

Bu Sun Kim

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

2020-05-01 07:42:23 -0700

[diff] [blame]

760

# Parameter ignored by server for input requests.

Bu Sun Kim

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

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

2020-05-20 12:08:20 -0700

[diff] [blame^]

771

"message": "A String", # A developer-facing error message, which should be in English. Any

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

772

# user-facing error message should be localized and sent in the

773

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

774

"details": [ # A list of messages that carry the error details. There is a common set of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

775

# message types for APIs to use.

776

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

777

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

778

},

779

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

780

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

781

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

782

"schedule": "A String", # Output only. Describes the schedule of this transfer run if it was

783

# created as part of a regular schedule. For batch transfer runs that are

784

# scheduled manually, this is empty.

785

# NOTE: the system might choose to delay the schedule depending on the

786

# current load, so `schedule_time` doesn't always match this.

787

"updateTime": "A String", # Output only. Last time the data transfer run state was updated.

788

"runTime": "A String", # For batch transfer runs, specifies the date and time of the data should be

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

789

# ingested.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

},

],

}</pre>

</div>

Dan O'Meara

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

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

a specific run_time.

Args:

parent: string, Transfer configuration name in the form:

Dan O'Meara

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

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

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

2019-06-14 16:50:42 -0700

[diff] [blame]

811

# run_time between start_time (inclusive) and end_time (exclusive).

Bu Sun Kim

2020-05-20 12:08:20 -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

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

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

2020-05-20 12:08:20 -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

2019-06-14 16:50:42 -0700

[diff] [blame]

820

},

Bu Sun Kim

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

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.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

832

833

{ # A response to start manual transfer runs.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

834

"runs": [ # The transfer runs that were created.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

835

{ # Represents a data transfer run.

Bu Sun Kim

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

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

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

2020-05-01 07:42:23 -0700

[diff] [blame]

845

# transfer run finishes

Bu Sun Kim

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

2020-05-01 07:42:23 -0700

[diff] [blame]

856

# Parameter ignored by server for input requests.

Bu Sun Kim

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

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

2020-05-20 12:08:20 -0700

[diff] [blame^]

867

"message": "A String", # A developer-facing error message, which should be in English. Any

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

868

# user-facing error message should be localized and sent in the

869

# google.rpc.Status.details field, or localized by the client.

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

870

"details": [ # A list of messages that carry the error details. There is a common set of

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

871

# message types for APIs to use.

872

{

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

873

"a_key": "", # Properties of the object. Contains field @type with type URL.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

874

},

875

],

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

876

"code": 42, # The status code, which should be an enum value of google.rpc.Code.

Bu Sun Kim

2019-06-14 16:50:42 -0700

[diff] [blame]

877

},

Bu Sun Kim

2020-05-20 12:08:20 -0700

[diff] [blame^]

878

"schedule": "A String", # Output only. Describes the schedule of this transfer run if it was

879

# created as part of a regular schedule. For batch transfer runs that are

880

# scheduled manually, this is empty.

881

# NOTE: the system might choose to delay the schedule depending on the

882

# current load, so `schedule_time` doesn't always match this.

883

"updateTime": "A String", # Output only. Last time the data transfer run state was updated.

884

"runTime": "A String", # For batch transfer runs, specifies the date and time of the data should be

Dan O'Meara

2020-05-01 07:42:23 -0700

[diff] [blame]

885

# ingested.

Sai Cheemalapati