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

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

[diff] [blame]

76

<h2>Instance Methods</h2>

77

Bu Sun Kim

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

[diff] [blame]

78

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

Sai Cheemalapati

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

[diff] [blame]

79

<p class="firstline">Returns true if valid credentials exist for the given data source and</p>

80

81

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

82

<p class="firstline">Retrieves a supported data source and returns its settings,</p>

83

Bu Sun Kim

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

[diff] [blame^]

84

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

Sai Cheemalapati

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

[diff] [blame]

85

<p class="firstline">Lists supported data sources and returns their settings,</p>

86

87

<code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>

88

<p class="firstline">Retrieves the next page of results.</p>

89

<h3>Method Details</h3>

90

Bu Sun Kim

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

[diff] [blame]

91

<code class="details" id="checkValidCreds">checkValidCreds(name, body=None, x__xgafv=None)</code>

Sai Cheemalapati

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

[diff] [blame]

92

<pre>Returns true if valid credentials exist for the given data source and

93

requesting user.

Bu Sun Kim

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

[diff] [blame^]

94

Some data sources doesn't support service account, so we need to talk to

Bu Sun Kim

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

[diff] [blame]

95

them on behalf of the end user. This API just checks whether we have OAuth

96

token for the particular user, which is a pre-requisite before user can

97

create a transfer config.

Sai Cheemalapati

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

[diff] [blame]

98

99

Args:

Dan O'Meara

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

[diff] [blame]

100

name: string, Required. The data source in the form:

101

`projects/{project_id}/dataSources/{data_source_id}` or

102

`projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}`. (required)

Bu Sun Kim

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

[diff] [blame]

103

body: object, The request body.

Sai Cheemalapati

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

[diff] [blame]

104

The object takes the form of:

105

106

{ # A request to determine whether the user has valid credentials. This method

107

# is used to limit the number of OAuth popups in the user interface. The

108

# user id is inferred from the API call context.

109

# If the data source has the Google+ authorization type, this method

110

# returns false, as it cannot be determined whether the credentials are

111

# already valid merely based on the user id.

112

}

113

114

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

121

122

{ # A response indicating whether the credentials exist and are valid.

Bu Sun Kim

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

[diff] [blame^]

123

"hasValidCreds": True or False, # If set to `true`, the credentials exist and are valid.

Sai Cheemalapati

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

[diff] [blame]

}</pre>

</div>

<code class="details" id="get">get(name, x__xgafv=None)</code>

129

<pre>Retrieves a supported data source and returns its settings,

130

which can be used for UI rendering.

131

132

Args:

Dan O'Meara

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

[diff] [blame]

133

name: string, Required. The field will contain name of the resource requested, for example:

134

`projects/{project_id}/dataSources/{data_source_id}` or

135

`projects/{project_id}/locations/{location_id}/dataSources/{data_source_id}` (required)

Sai Cheemalapati

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

[diff] [blame]

136

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

143

144

{ # Represents data source metadata. Metadata is sufficient to

145

# render UI and request proper OAuth tokens.

Bu Sun Kim

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

[diff] [blame^]

146

"dataSourceId": "A String", # Data source id.

147

"scopes": [ # Api auth scopes for which refresh token needs to be obtained. These are

Bu Sun Kim

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

[diff] [blame]

148

# scopes needed by a data source to prepare data and ingest them into

149

# BigQuery, e.g., https://www.googleapis.com/auth/bigquery

Bu Sun Kim

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

[diff] [blame^]

150

"A String",

Sai Cheemalapati

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

[diff] [blame]

151

],

Bu Sun Kim

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

[diff] [blame^]

152

"name": "A String", # Output only. Data source resource name.

153

"minimumScheduleInterval": "A String", # The minimum interval for scheduler to schedule runs.

154

"clientId": "A String", # Data source client id which should be used to receive refresh token.

155

"authorizationType": "A String", # Indicates the type of authorization.

156

"supportsCustomSchedule": True or False, # Specifies whether the data source supports a user defined schedule, or

Bu Sun Kim

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

[diff] [blame]

157

# operates on the default schedule.

158

# When set to `true`, user can override default schedule.

Bu Sun Kim

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

[diff] [blame^]

159

"displayName": "A String", # User friendly data source name.

160

"updateDeadlineSeconds": 42, # The number of seconds to wait for an update from the data source

161

# before the Data Transfer Service marks the transfer as FAILED.

162

"dataRefreshType": "A String", # Specifies whether the data source supports automatic data refresh for the

163

# past few days, and how it's supported.

Sai Cheemalapati

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

[diff] [blame]

164

# For some data sources, data might not be complete until a few days later,

Bu Sun Kim

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

[diff] [blame^]

165

# so it's useful to refresh data automatically.

166

"parameters": [ # Data source parameters.

Dan O'Meara

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

[diff] [blame]

167

{ # Represents a data source parameter with validation rules, so that

168

# parameters can be rendered in the UI. These parameters are given to us by

169

# supported data sources, and include all needed information for rendering

170

# and validation.

171

# Thus, whoever uses this api can decide to generate either generic ui,

172

# or custom data source specific forms.

Bu Sun Kim

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

[diff] [blame^]

173

"repeated": True or False, # Deprecated. This field has no effect.

174

"displayName": "A String", # Parameter display name in the user interface.

175

"immutable": True or False, # Cannot be changed after initial creation.

176

"validationDescription": "A String", # Description of the requirements for this field, in case the user input does

Dan O'Meara

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

[diff] [blame]

177

# not fulfill the regex pattern or min/max values.

Bu Sun Kim

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

[diff] [blame^]

178

"deprecated": True or False, # If true, it should not be used in new transfers, and it should not be

Dan O'Meara

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

[diff] [blame]

179

# visible to users.

Bu Sun Kim

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

[diff] [blame^]

180

"fields": [ # Deprecated. This field has no effect.

Dan O'Meara

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

[diff] [blame]

181

# Object with schema name: DataSourceParameter

182

],

Bu Sun Kim

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

[diff] [blame^]

183

"maxValue": 3.14, # For integer and double values specifies maxminum allowed value.

184

"type": "A String", # Parameter type.

185

"recurse": True or False, # Deprecated. This field has no effect.

186

"description": "A String", # Parameter description.

187

"allowedValues": [ # All possible values for the parameter.

188

"A String",

Dan O'Meara

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

[diff] [blame]

189

],

Bu Sun Kim

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

[diff] [blame^]

190

"minValue": 3.14, # For integer and double values specifies minimum allowed value.

191

"validationHelpUrl": "A String", # URL to a help document to further explain the naming requirements.

192

"validationRegex": "A String", # Regular expression which can be used for parameter validation.

193

"paramId": "A String", # Parameter identifier.

194

"required": True or False, # Is parameter required.

Dan O'Meara

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

[diff] [blame]

195

},

196

],

Bu Sun Kim

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

[diff] [blame^]

197

"helpUrl": "A String", # Url for the help document for this data source.

198

"defaultSchedule": "A String", # Default data transfer schedule.

Sai Cheemalapati

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

[diff] [blame]

199

# Examples of valid schedules include:

200

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

201

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

202

# `first sunday of quarter 00:00`.

Bu Sun Kim

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

[diff] [blame^]

203

"supportsMultipleTransfers": True or False, # Deprecated. This field has no effect.

204

"defaultDataRefreshWindowDays": 42, # Default data refresh window on days.

Sai Cheemalapati

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

[diff] [blame]

205

# Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.

Bu Sun Kim

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

[diff] [blame^]

206

"manualRunsDisabled": True or False, # Disables backfilling and manual run scheduling

207

# for the data source.

208

"transferType": "A String", # Deprecated. This field has no effect.

209

"description": "A String", # User friendly data source description string.

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^]

214

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

Sai Cheemalapati

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

[diff] [blame]

215

<pre>Lists supported data sources and returns their settings,

216

which can be used for UI rendering.

217

218

Args:

Dan O'Meara

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

[diff] [blame]

219

parent: string, Required. The BigQuery project id for which data sources should be returned.

220

Must be in the form: `projects/{project_id}` or

221

`projects/{project_id}/locations/{location_id} (required)

Sai Cheemalapati

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

[diff] [blame]

222

pageToken: string, Pagination token, which can be used to request a specific page

223

of `ListDataSourcesRequest` list results. For multiple-page

224

results, `ListDataSourcesResponse` outputs

225

a `next_page` token, which can be used as the

226

`page_token` value to request the next page of list results.

Bu Sun Kim

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

[diff] [blame^]

227

pageSize: integer, Page size. The default page size is the maximum value of 1000 results.

Sai Cheemalapati

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

[diff] [blame]

228

x__xgafv: string, V1 error format.

229

Allowed values

230

1 - v1 error format

231

2 - v2 error format

Sai Cheemalapati

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

[diff] [blame]

232

233

Returns:

234

An object of the form:

235

236

{ # Returns list of supported data sources and their metadata.

Bu Sun Kim

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

[diff] [blame^]

237

"dataSources": [ # List of supported data sources and their transfer settings.

Sai Cheemalapati

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

[diff] [blame]

238

{ # Represents data source metadata. Metadata is sufficient to

239

# render UI and request proper OAuth tokens.

Bu Sun Kim

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

[diff] [blame^]

240

"dataSourceId": "A String", # Data source id.

241

"scopes": [ # Api auth scopes for which refresh token needs to be obtained. These are

Bu Sun Kim

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

[diff] [blame]

242

# scopes needed by a data source to prepare data and ingest them into

243

# BigQuery, e.g., https://www.googleapis.com/auth/bigquery

Bu Sun Kim

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

[diff] [blame^]

244

"A String",

Sai Cheemalapati

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

[diff] [blame]

245

],

Bu Sun Kim

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

[diff] [blame^]

246

"name": "A String", # Output only. Data source resource name.

247

"minimumScheduleInterval": "A String", # The minimum interval for scheduler to schedule runs.

248

"clientId": "A String", # Data source client id which should be used to receive refresh token.

249

"authorizationType": "A String", # Indicates the type of authorization.

250

"supportsCustomSchedule": True or False, # Specifies whether the data source supports a user defined schedule, or

Bu Sun Kim

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

[diff] [blame]

251

# operates on the default schedule.

252

# When set to `true`, user can override default schedule.

Bu Sun Kim

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

[diff] [blame^]

253

"displayName": "A String", # User friendly data source name.

254

"updateDeadlineSeconds": 42, # The number of seconds to wait for an update from the data source

255

# before the Data Transfer Service marks the transfer as FAILED.

256

"dataRefreshType": "A String", # Specifies whether the data source supports automatic data refresh for the

257

# past few days, and how it's supported.

Sai Cheemalapati

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

[diff] [blame]

258

# For some data sources, data might not be complete until a few days later,

Bu Sun Kim

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

[diff] [blame^]

259

# so it's useful to refresh data automatically.

260

"parameters": [ # Data source parameters.

Dan O'Meara

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

[diff] [blame]

261

{ # Represents a data source parameter with validation rules, so that

262

# parameters can be rendered in the UI. These parameters are given to us by

263

# supported data sources, and include all needed information for rendering

264

# and validation.

265

# Thus, whoever uses this api can decide to generate either generic ui,

266

# or custom data source specific forms.

Bu Sun Kim

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

[diff] [blame^]

267

"repeated": True or False, # Deprecated. This field has no effect.

268

"displayName": "A String", # Parameter display name in the user interface.

269

"immutable": True or False, # Cannot be changed after initial creation.

270

"validationDescription": "A String", # Description of the requirements for this field, in case the user input does

Dan O'Meara

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

[diff] [blame]

271

# not fulfill the regex pattern or min/max values.

Bu Sun Kim

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

[diff] [blame^]

272

"deprecated": True or False, # If true, it should not be used in new transfers, and it should not be

Dan O'Meara

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

[diff] [blame]

273

# visible to users.

Bu Sun Kim

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

[diff] [blame^]

274

"fields": [ # Deprecated. This field has no effect.

Dan O'Meara

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

[diff] [blame]

275

# Object with schema name: DataSourceParameter

276

],

Bu Sun Kim

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

[diff] [blame^]

277

"maxValue": 3.14, # For integer and double values specifies maxminum allowed value.

278

"type": "A String", # Parameter type.

279

"recurse": True or False, # Deprecated. This field has no effect.

280

"description": "A String", # Parameter description.

281

"allowedValues": [ # All possible values for the parameter.

282

"A String",

Dan O'Meara

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

[diff] [blame]

283

],

Bu Sun Kim

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

[diff] [blame^]

284

"minValue": 3.14, # For integer and double values specifies minimum allowed value.

285

"validationHelpUrl": "A String", # URL to a help document to further explain the naming requirements.

286

"validationRegex": "A String", # Regular expression which can be used for parameter validation.

287

"paramId": "A String", # Parameter identifier.

288

"required": True or False, # Is parameter required.

Dan O'Meara

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

[diff] [blame]

289

},

290

],

Bu Sun Kim

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

[diff] [blame^]

291

"helpUrl": "A String", # Url for the help document for this data source.

292

"defaultSchedule": "A String", # Default data transfer schedule.

Sai Cheemalapati

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

[diff] [blame]

293

# Examples of valid schedules include:

294

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

295

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

296

# `first sunday of quarter 00:00`.

Bu Sun Kim

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

[diff] [blame^]

297

"supportsMultipleTransfers": True or False, # Deprecated. This field has no effect.

298

"defaultDataRefreshWindowDays": 42, # Default data refresh window on days.

Sai Cheemalapati

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

[diff] [blame]

299

# Only meaningful when `data_refresh_type` = `SLIDING_WINDOW`.

Bu Sun Kim

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

[diff] [blame^]

300

"manualRunsDisabled": True or False, # Disables backfilling and manual run scheduling

301

# for the data source.

302

"transferType": "A String", # Deprecated. This field has no effect.

303

"description": "A String", # User friendly data source description string.

Sai Cheemalapati

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

[diff] [blame]

304

},

305

],

Bu Sun Kim

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

[diff] [blame^]

306

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

307

# this token can be used as the

308

# `ListDataSourcesRequest.page_token`

309

# to request the next page of list results.

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>

315

<pre>Retrieves the next page of results.

316

317

Args:

318

previous_request: The request for the previous page. (required)

319

previous_response: The response from the request for the previous page. (required)

320

321

Returns:

Bu Sun Kim

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

[diff] [blame^]

322

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

Sai Cheemalapati