Blame - docs/dyn/datastream_v1.projects.locations.streams.objects.html - platform/external/python/google-api-python-client

<h1><a href="datastream_v1.html">Datastream API</a> . <a href="datastream_v1.projects.html">projects</a> . <a href="datastream_v1.projects.locations.html">locations</a> . <a href="datastream_v1.projects.locations.streams.html">streams</a> . <a href="datastream_v1.projects.locations.streams.objects.html">objects</a></h1>

76

<h2>Instance Methods</h2>

77

78

<code><a href="#close">close()</a></code></p>

79

<p class="firstline">Close httplib2 connections.</p>

80

81

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

82

<p class="firstline">Use this method to get details about a stream object.</p>

83

84

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

85

<p class="firstline">Use this method to list the objects of a specific stream.</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

90

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

91

<p class="firstline">Use this method to look up a stream object by its source object identifier.</p>

92

93

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

94

<p class="firstline">Starts backfill job for the specified stream object.</p>

95

96

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

97

<p class="firstline">Stops the backfill job for the specified stream object.</p>

98

<h3>Method Details</h3>

99

100

<code class="details" id="close">close()</code>

101

<pre>Close httplib2 connections.</pre>

</div>

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

106

<pre>Use this method to get details about a stream object.

107

108

Args:

109

name: string, Required. The name of the stream object resource to get. (required)

110

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

117

118

{ # A specific stream object (e.g a specific DB table).

119

"backfillJob": { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object.

120

"errors": [ # Output only. Errors which caused the backfill job to fail.

121

{ # Represent a user-facing Error.

122

"details": { # Additional information about the error.

123

"a_key": "A String",

124

},

125

"errorTime": "A String", # The time when the error occurred.

126

"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.

127

"message": "A String", # A message containing more information about the error that occurred.

128

"reason": "A String", # A title that explains the reason for the error.

129

},

130

],

131

"lastEndTime": "A String", # Output only. Backfill job's end time.

132

"lastStartTime": "A String", # Output only. Backfill job's start time.

133

"state": "A String", # Backfill job state.

134

"trigger": "A String", # Backfill job's triggering reason.

135

},

136

"createTime": "A String", # Output only. The creation time of the object.

137

"displayName": "A String", # Required. Display name.

138

"errors": [ # Output only. Active errors on the object.

139

{ # Represent a user-facing Error.

140

"details": { # Additional information about the error.

141

"a_key": "A String",

142

},

143

"errorTime": "A String", # The time when the error occurred.

144

"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.

145

"message": "A String", # A message containing more information about the error that occurred.

146

"reason": "A String", # A title that explains the reason for the error.

147

},

148

],

149

"name": "A String", # Output only. The object resource's name.

150

"sourceObject": { # Represents an identifier of an object in the data source. # The object identifier in the data source.

151

"mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier.

152

"database": "A String", # The database name.

153

"table": "A String", # The table name.

154

},

155

"oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier.

156

"schema": "A String", # The schema name.

157

"table": "A String", # The table name.

158

},

159

},

160

"updateTime": "A String", # Output only. The last update time of the object.

}</pre>

</div>

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

166

<pre>Use this method to list the objects of a specific stream.

167

168

Args:

169

parent: string, Required. The parent stream that owns the collection of objects. (required)

170

pageSize: integer, Maximum number of objects to return. Default is 50. The maximum value is 1000; values above 1000 will be coerced to 1000.

171

pageToken: string, Page token received from a previous `ListStreamObjectsRequest` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListStreamObjectsRequest` must match the call that provided the page token.

172

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

179

180

{ # Response containing the objects for a stream.

181

"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page.

182

"streamObjects": [ # List of stream objects.

183

{ # A specific stream object (e.g a specific DB table).

184

"backfillJob": { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object.

185

"errors": [ # Output only. Errors which caused the backfill job to fail.

186

{ # Represent a user-facing Error.

187

"details": { # Additional information about the error.

188

"a_key": "A String",

189

},

190

"errorTime": "A String", # The time when the error occurred.

191

"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.

192

"message": "A String", # A message containing more information about the error that occurred.

193

"reason": "A String", # A title that explains the reason for the error.

194

},

195

],

196

"lastEndTime": "A String", # Output only. Backfill job's end time.

197

"lastStartTime": "A String", # Output only. Backfill job's start time.

198

"state": "A String", # Backfill job state.

199

"trigger": "A String", # Backfill job's triggering reason.

200

},

201

"createTime": "A String", # Output only. The creation time of the object.

202

"displayName": "A String", # Required. Display name.

203

"errors": [ # Output only. Active errors on the object.

204

{ # Represent a user-facing Error.

205

"details": { # Additional information about the error.

206

"a_key": "A String",

207

},

208

"errorTime": "A String", # The time when the error occurred.

209

"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.

210

"message": "A String", # A message containing more information about the error that occurred.

211

"reason": "A String", # A title that explains the reason for the error.

212

},

213

],

214

"name": "A String", # Output only. The object resource's name.

215

"sourceObject": { # Represents an identifier of an object in the data source. # The object identifier in the data source.

216

"mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier.

217

"database": "A String", # The database name.

218

"table": "A String", # The table name.

219

},

220

"oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier.

221

"schema": "A String", # The schema name.

222

"table": "A String", # The table name.

223

},

224

},

225

"updateTime": "A String", # Output only. The last update time of the object.

},

],

}</pre>

</div>

<code class="details" id="list_next">list_next(previous_request, previous_response)</code>

233

<pre>Retrieves the next page of results.

234

235

Args:

236

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

237

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

238

239

Returns:

240

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

241

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

</pre>

</div>

<code class="details" id="lookup">lookup(parent, body=None, x__xgafv=None)</code>

247

<pre>Use this method to look up a stream object by its source object identifier.

248

249

Args:

250

parent: string, Required. The parent stream that owns the collection of objects. (required)

251

body: object, The request body.

252

The object takes the form of:

253

254

{ # Request for looking up a specific stream object by its source object identifier.

255

"sourceObjectIdentifier": { # Represents an identifier of an object in the data source. # Required. The source object identifier which maps to the stream object.

256

"mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier.

257

"database": "A String", # The database name.

258

"table": "A String", # The table name.

259

},

260

"oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier.

261

"schema": "A String", # The schema name.

262

"table": "A String", # The table name.

},

},

}

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

274

275

{ # A specific stream object (e.g a specific DB table).

276

"backfillJob": { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object.

277

"errors": [ # Output only. Errors which caused the backfill job to fail.

278

{ # Represent a user-facing Error.

279

"details": { # Additional information about the error.

280

"a_key": "A String",

281

},

282

"errorTime": "A String", # The time when the error occurred.

283

"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.

284

"message": "A String", # A message containing more information about the error that occurred.

285

"reason": "A String", # A title that explains the reason for the error.

286

},

287

],

288

"lastEndTime": "A String", # Output only. Backfill job's end time.

289

"lastStartTime": "A String", # Output only. Backfill job's start time.

290

"state": "A String", # Backfill job state.

291

"trigger": "A String", # Backfill job's triggering reason.

292

},

293

"createTime": "A String", # Output only. The creation time of the object.

294

"displayName": "A String", # Required. Display name.

295

"errors": [ # Output only. Active errors on the object.

296

{ # Represent a user-facing Error.

297

"details": { # Additional information about the error.

298

"a_key": "A String",

299

},

300

"errorTime": "A String", # The time when the error occurred.

301

"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.

302

"message": "A String", # A message containing more information about the error that occurred.

303

"reason": "A String", # A title that explains the reason for the error.

304

},

305

],

306

"name": "A String", # Output only. The object resource's name.

307

"sourceObject": { # Represents an identifier of an object in the data source. # The object identifier in the data source.

308

"mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier.

309

"database": "A String", # The database name.

310

"table": "A String", # The table name.

311

},

312

"oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier.

313

"schema": "A String", # The schema name.

314

"table": "A String", # The table name.

315

},

316

},

317

"updateTime": "A String", # Output only. The last update time of the object.

}</pre>

</div>

<code class="details" id="startBackfillJob">startBackfillJob(object, body=None, x__xgafv=None)</code>

323

<pre>Starts backfill job for the specified stream object.

324

325

Args:

326

object: string, Required. The name of the stream object resource to start a backfill job for. (required)

327

body: object, The request body.

328

The object takes the form of:

329

330

{ # Request for manually initiating a backfill job for a specific stream object.

331

}

332

333

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

340

341

{ # Response for manually initiating a backfill job for a specific stream object.

342

"object": { # A specific stream object (e.g a specific DB table). # The stream object resource a backfill job was started for.

343

"backfillJob": { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object.

344

"errors": [ # Output only. Errors which caused the backfill job to fail.

345

{ # Represent a user-facing Error.

346

"details": { # Additional information about the error.

347

"a_key": "A String",

348

},

349

"errorTime": "A String", # The time when the error occurred.

350

"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.

351

"message": "A String", # A message containing more information about the error that occurred.

352

"reason": "A String", # A title that explains the reason for the error.

353

},

354

],

355

"lastEndTime": "A String", # Output only. Backfill job's end time.

356

"lastStartTime": "A String", # Output only. Backfill job's start time.

357

"state": "A String", # Backfill job state.

358

"trigger": "A String", # Backfill job's triggering reason.

359

},

360

"createTime": "A String", # Output only. The creation time of the object.

361

"displayName": "A String", # Required. Display name.

362

"errors": [ # Output only. Active errors on the object.

363

{ # Represent a user-facing Error.

364

"details": { # Additional information about the error.

365

"a_key": "A String",

366

},

367

"errorTime": "A String", # The time when the error occurred.

368

"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.

369

"message": "A String", # A message containing more information about the error that occurred.

370

"reason": "A String", # A title that explains the reason for the error.

371

},

372

],

373

"name": "A String", # Output only. The object resource's name.

374

"sourceObject": { # Represents an identifier of an object in the data source. # The object identifier in the data source.

375

"mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier.

376

"database": "A String", # The database name.

377

"table": "A String", # The table name.

378

},

379

"oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier.

380

"schema": "A String", # The schema name.

381

"table": "A String", # The table name.

382

},

383

},

384

"updateTime": "A String", # Output only. The last update time of the object.

},

}</pre>

</div>

<code class="details" id="stopBackfillJob">stopBackfillJob(object, body=None, x__xgafv=None)</code>

391

<pre>Stops the backfill job for the specified stream object.

392

393

Args:

394

object: string, Required. The name of the stream object resource to stop the backfill job for. (required)

395

body: object, The request body.

396

The object takes the form of:

397

398

{ # Request for manually stopping a running backfill job for a specific stream object.

399

}

400

401

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

408

409

{ # Response for manually stop a backfill job for a specific stream object.

410

"object": { # A specific stream object (e.g a specific DB table). # The stream object resource the backfill job was stopped for.

411

"backfillJob": { # Represents a backfill job on a specific stream object. # The latest backfill job that was initiated for the stream object.

412

"errors": [ # Output only. Errors which caused the backfill job to fail.

413

{ # Represent a user-facing Error.

414

"details": { # Additional information about the error.

415

"a_key": "A String",

416

},

417

"errorTime": "A String", # The time when the error occurred.

418

"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.

419

"message": "A String", # A message containing more information about the error that occurred.

420

"reason": "A String", # A title that explains the reason for the error.

421

},

422

],

423

"lastEndTime": "A String", # Output only. Backfill job's end time.

424

"lastStartTime": "A String", # Output only. Backfill job's start time.

425

"state": "A String", # Backfill job state.

426

"trigger": "A String", # Backfill job's triggering reason.

427

},

428

"createTime": "A String", # Output only. The creation time of the object.

429

"displayName": "A String", # Required. Display name.

430

"errors": [ # Output only. Active errors on the object.

431

{ # Represent a user-facing Error.

432

"details": { # Additional information about the error.

433

"a_key": "A String",

434

},

435

"errorTime": "A String", # The time when the error occurred.

436

"errorUuid": "A String", # A unique identifier for this specific error, allowing it to be traced throughout the system in logs and API responses.

437

"message": "A String", # A message containing more information about the error that occurred.

438

"reason": "A String", # A title that explains the reason for the error.

439

},

440

],

441

"name": "A String", # Output only. The object resource's name.

442

"sourceObject": { # Represents an identifier of an object in the data source. # The object identifier in the data source.

443

"mysqlIdentifier": { # Mysql data source object identifier. # Mysql data source object identifier.

444

"database": "A String", # The database name.

445

"table": "A String", # The table name.

446

},

447

"oracleIdentifier": { # Oracle data source object identifier. # Oracle data source object identifier.

448

"schema": "A String", # The schema name.

449

"table": "A String", # The table name.

450

},

451

},

452

"updateTime": "A String", # Output only. The last update time of the object.

},

}</pre>

</div>

</body></html>