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

<h1><a href="datastream_v1alpha1.html">Datastream API</a> . <a href="datastream_v1alpha1.projects.html">projects</a> . <a href="datastream_v1alpha1.projects.locations.html">locations</a> . <a href="datastream_v1alpha1.projects.locations.streams.html">streams</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="#create">create(parent, body=None, force=None, requestId=None, streamId=None, validateOnly=None, x__xgafv=None)</a></code></p>

82

<p class="firstline">Use this method to create a stream.</p>

83

84

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

85

<p class="firstline">Use this method to delete a stream.</p>

86

87

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

88

<p class="firstline">Use this method to fetch any errors associated with a stream.</p>

89

90

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

91

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

92

93

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

94

<p class="firstline">Use this method to list streams in a project and location.</p>

95

96

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

97

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

98

99

<code><a href="#patch">patch(name, body=None, force=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</a></code></p>

100

<p class="firstline">Use this method to update the configuration of a stream.</p>

101

<h3>Method Details</h3>

102

103

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

104

<pre>Close httplib2 connections.</pre>

</div>

<code class="details" id="create">create(parent, body=None, force=None, requestId=None, streamId=None, validateOnly=None, x__xgafv=None)</code>

109

<pre>Use this method to create a stream.

110

111

Args:

112

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

113

body: object, The request body.

114

The object takes the form of:

115

116

{

117

"backfillAll": { # Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded. # Automatically backfill objects included in the stream source configuration. Specific objects can be excluded.

118

"mysqlExcludedObjects": { # MySQL database structure # MySQL data source objects to avoid backfilling.

119

"mysqlDatabases": [ # Mysql databases on the server

120

{ # MySQL database.

121

"databaseName": "A String", # Database name.

122

"mysqlTables": [ # Tables in the database.

123

{ # MySQL table.

124

"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.

125

{ # MySQL Column.

126

"collation": "A String", # Column collation.

127

"columnName": "A String", # Column name.

128

"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html

129

"length": 42, # Column length.

130

"nullable": True or False, # Whether or not the column can accept a null value.

131

"ordinalPosition": 42, # The ordinal position of the column in the table.

132

"primaryKey": True or False, # Whether or not the column represents a primary key.

133

},

134

],

135

"tableName": "A String", # Table name.

},

],

},

],

},

"oracleExcludedObjects": { # Oracle database structure. # Oracle data source objects to avoid backfilling.

142

"oracleSchemas": [ # Oracle schemas/databases in the database server.

143

{ # Oracle schema.

144

"oracleTables": [ # Tables in the schema.

145

{ # Oracle table.

146

"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.

147

{ # Oracle Column.

148

"columnName": "A String", # Column name.

149

"dataType": "A String", # The Oracle data type.

150

"encoding": "A String", # Column encoding.

151

"length": 42, # Column length.

152

"nullable": True or False, # Whether or not the column can accept a null value.

153

"ordinalPosition": 42, # The ordinal position of the column in the table.

154

"precision": 42, # Column precision.

155

"primaryKey": True or False, # Whether or not the column represents a primary key.

156

"scale": 42, # Column scale.

157

},

158

],

159

"tableName": "A String", # Table name.

160

},

161

],

162

"schemaName": "A String", # Schema name.

},

],

},

},

"backfillNone": { # Backfill strategy to disable automatic backfill for the Stream's objects. # Do not automatically backfill any objects.

168

},

169

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

yoshi-code-bot

5dcb723

2021-11-08 23:24:14 -0800

[diff] [blame]

170

"customerManagedEncryptionKey": "A String", # Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS.

yoshi-code-bot

12d387c

2021-10-26 00:24:32 -0700

[diff] [blame]

171

"destinationConfig": { # The configuration of the stream destination. # Required. Destination connection profile configuration.

172

"destinationConnectionProfileName": "A String", # Required. Destination connection profile identifier.

173

"gcsDestinationConfig": { # Google Cloud Storage destination configuration

174

"avroFileFormat": { # AVRO file format configuration. # AVRO file format configuration.

175

},

176

"fileRotationInterval": "A String", # The maximum duration for which new events are added before a file is closed and a new file is created.

177

"fileRotationMb": 42, # The maximum file size to be saved in the bucket.

178

"gcsFileFormat": "A String", # File format that data should be written in. Deprecated field (b/169501737) - use file_format instead.

179

"jsonFileFormat": { # JSON file format configuration. # JSON file format configuration.

180

"compression": "A String", # Compression of the loaded JSON file.

181

"schemaFileFormat": "A String", # The schema file format along JSON data files.

182

},

183

"path": "A String", # Path inside the Cloud Storage bucket to write data to.

184

},

185

},

186

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

187

"errors": [ # Output only. Errors on the Stream.

188

{ # Represent a user-facing Error.

189

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

190

"a_key": "A String",

191

},

192

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

193

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

194

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

195

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

196

},

197

],

198

"labels": { # Labels.

199

"a_key": "A String",

200

},

201

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

202

"sourceConfig": { # The configuration of the stream source. # Required. Source connection profile configuration.

203

"mysqlSourceConfig": { # MySQL source configuration # MySQL data source configuration

204

"allowlist": { # MySQL database structure # MySQL objects to retrieve from the source.

205

"mysqlDatabases": [ # Mysql databases on the server

206

{ # MySQL database.

207

"databaseName": "A String", # Database name.

208

"mysqlTables": [ # Tables in the database.

209

{ # MySQL table.

210

"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.

211

{ # MySQL Column.

212

"collation": "A String", # Column collation.

213

"columnName": "A String", # Column name.

214

"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html

215

"length": 42, # Column length.

216

"nullable": True or False, # Whether or not the column can accept a null value.

217

"ordinalPosition": 42, # The ordinal position of the column in the table.

218

"primaryKey": True or False, # Whether or not the column represents a primary key.

219

},

220

],

221

"tableName": "A String", # Table name.

},

],

},

],

},

"rejectlist": { # MySQL database structure # MySQL objects to exclude from the stream.

228

"mysqlDatabases": [ # Mysql databases on the server

229

{ # MySQL database.

230

"databaseName": "A String", # Database name.

231

"mysqlTables": [ # Tables in the database.

232

{ # MySQL table.

233

"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.

234

{ # MySQL Column.

235

"collation": "A String", # Column collation.

236

"columnName": "A String", # Column name.

237

"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html

238

"length": 42, # Column length.

239

"nullable": True or False, # Whether or not the column can accept a null value.

240

"ordinalPosition": 42, # The ordinal position of the column in the table.

241

"primaryKey": True or False, # Whether or not the column represents a primary key.

242

},

243

],

244

"tableName": "A String", # Table name.

},

],

},

],

},

},

"oracleSourceConfig": { # Oracle data source configuration # Oracle data source configuration

252

"allowlist": { # Oracle database structure. # Oracle objects to include in the stream.

253

"oracleSchemas": [ # Oracle schemas/databases in the database server.

254

{ # Oracle schema.

255

"oracleTables": [ # Tables in the schema.

256

{ # Oracle table.

257

"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.

258

{ # Oracle Column.

259

"columnName": "A String", # Column name.

260

"dataType": "A String", # The Oracle data type.

261

"encoding": "A String", # Column encoding.

262

"length": 42, # Column length.

263

"nullable": True or False, # Whether or not the column can accept a null value.

264

"ordinalPosition": 42, # The ordinal position of the column in the table.

265

"precision": 42, # Column precision.

266

"primaryKey": True or False, # Whether or not the column represents a primary key.

267

"scale": 42, # Column scale.

268

},

269

],

270

"tableName": "A String", # Table name.

271

},

272

],

273

"schemaName": "A String", # Schema name.

},

],

},

"rejectlist": { # Oracle database structure. # Oracle objects to exclude from the stream.

278

"oracleSchemas": [ # Oracle schemas/databases in the database server.

279

{ # Oracle schema.

280

"oracleTables": [ # Tables in the schema.

281

{ # Oracle table.

282

"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.

283

{ # Oracle Column.

284

"columnName": "A String", # Column name.

285

"dataType": "A String", # The Oracle data type.

286

"encoding": "A String", # Column encoding.

287

"length": 42, # Column length.

288

"nullable": True or False, # Whether or not the column can accept a null value.

289

"ordinalPosition": 42, # The ordinal position of the column in the table.

290

"precision": 42, # Column precision.

291

"primaryKey": True or False, # Whether or not the column represents a primary key.

292

"scale": 42, # Column scale.

293

},

294

],

295

"tableName": "A String", # Table name.

296

},

297

],

298

"schemaName": "A String", # Schema name.

},

],

},

},

"sourceConnectionProfileName": "A String", # Required. Source connection profile identifier.

304

},

305

"state": "A String", # The state of the stream.

306

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

307

}

308

309

force: boolean, Optional. Create the stream without validating it.

310

requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

311

streamId: string, Required. The stream identifier.

312

validateOnly: boolean, Optional. Only validate the stream, but do not create any resources. The default is false.

313

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

320

321

{ # This resource represents a long-running operation that is the result of a network API call.

322

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

323

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

324

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

325

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

326

{

327

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

328

},

329

],

330

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

331

},

332

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

333

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

334

},

335

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

336

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

337

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

},

}</pre>

</div>

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

344

<pre>Use this method to delete a stream.

Args:

requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes after the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

349

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

356

357

{ # This resource represents a long-running operation that is the result of a network API call.

358

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

359

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

360

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

361

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

362

{

363

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

364

},

365

],

366

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

367

},

368

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

369

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

370

},

371

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

372

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

373

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

},

}</pre>

</div>

<code class="details" id="fetchErrors">fetchErrors(stream, body=None, x__xgafv=None)</code>

380

<pre>Use this method to fetch any errors associated with a stream.

381

382

Args:

383

stream: string, Name of the Stream resource for which to fetch any errors. (required)

384

body: object, The request body.

385

The object takes the form of:

386

387

{ # Request message for 'FetchErrors' request.

388

}

389

390

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

397

398

{ # This resource represents a long-running operation that is the result of a network API call.

399

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

400

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

401

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

402

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

403

{

404

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

405

},

406

],

407

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

408

},

409

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

410

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

411

},

412

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

413

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

414

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

},

}</pre>

</div>

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

421

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

Args:

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

432

433

{

434

"backfillAll": { # Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded. # Automatically backfill objects included in the stream source configuration. Specific objects can be excluded.

435

"mysqlExcludedObjects": { # MySQL database structure # MySQL data source objects to avoid backfilling.

436

"mysqlDatabases": [ # Mysql databases on the server

437

{ # MySQL database.

438

"databaseName": "A String", # Database name.

439

"mysqlTables": [ # Tables in the database.

440

{ # MySQL table.

441

"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.

442

{ # MySQL Column.

443

"collation": "A String", # Column collation.

444

"columnName": "A String", # Column name.

445

"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html

446

"length": 42, # Column length.

447

"nullable": True or False, # Whether or not the column can accept a null value.

448

"ordinalPosition": 42, # The ordinal position of the column in the table.

449

"primaryKey": True or False, # Whether or not the column represents a primary key.

450

},

451

],

452

"tableName": "A String", # Table name.

},

],

},

],

},

"oracleExcludedObjects": { # Oracle database structure. # Oracle data source objects to avoid backfilling.

459

"oracleSchemas": [ # Oracle schemas/databases in the database server.

460

{ # Oracle schema.

461

"oracleTables": [ # Tables in the schema.

462

{ # Oracle table.

463

"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.

464

{ # Oracle Column.

465

"columnName": "A String", # Column name.

466

"dataType": "A String", # The Oracle data type.

467

"encoding": "A String", # Column encoding.

468

"length": 42, # Column length.

469

"nullable": True or False, # Whether or not the column can accept a null value.

470

"ordinalPosition": 42, # The ordinal position of the column in the table.

471

"precision": 42, # Column precision.

472

"primaryKey": True or False, # Whether or not the column represents a primary key.

473

"scale": 42, # Column scale.

474

},

475

],

476

"tableName": "A String", # Table name.

477

},

478

],

479

"schemaName": "A String", # Schema name.

},

],

},

},

"backfillNone": { # Backfill strategy to disable automatic backfill for the Stream's objects. # Do not automatically backfill any objects.

485

},

486

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

yoshi-code-bot

5dcb723

2021-11-08 23:24:14 -0800

[diff] [blame]

487

"customerManagedEncryptionKey": "A String", # Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS.

yoshi-code-bot

12d387c

2021-10-26 00:24:32 -0700

[diff] [blame]

488

"destinationConfig": { # The configuration of the stream destination. # Required. Destination connection profile configuration.

489

"destinationConnectionProfileName": "A String", # Required. Destination connection profile identifier.

490

"gcsDestinationConfig": { # Google Cloud Storage destination configuration

491

"avroFileFormat": { # AVRO file format configuration. # AVRO file format configuration.

492

},

493

"fileRotationInterval": "A String", # The maximum duration for which new events are added before a file is closed and a new file is created.

494

"fileRotationMb": 42, # The maximum file size to be saved in the bucket.

495

"gcsFileFormat": "A String", # File format that data should be written in. Deprecated field (b/169501737) - use file_format instead.

496

"jsonFileFormat": { # JSON file format configuration. # JSON file format configuration.

497

"compression": "A String", # Compression of the loaded JSON file.

498

"schemaFileFormat": "A String", # The schema file format along JSON data files.

499

},

500

"path": "A String", # Path inside the Cloud Storage bucket to write data to.

501

},

502

},

503

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

504

"errors": [ # Output only. Errors on the Stream.

505

{ # Represent a user-facing Error.

506

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

507

"a_key": "A String",

508

},

509

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

510

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

511

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

512

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

513

},

514

],

515

"labels": { # Labels.

516

"a_key": "A String",

517

},

518

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

519

"sourceConfig": { # The configuration of the stream source. # Required. Source connection profile configuration.

520

"mysqlSourceConfig": { # MySQL source configuration # MySQL data source configuration

521

"allowlist": { # MySQL database structure # MySQL objects to retrieve from the source.

522

"mysqlDatabases": [ # Mysql databases on the server

523

{ # MySQL database.

524

"databaseName": "A String", # Database name.

525

"mysqlTables": [ # Tables in the database.

526

{ # MySQL table.

527

"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.

528

{ # MySQL Column.

529

"collation": "A String", # Column collation.

530

"columnName": "A String", # Column name.

531

"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html

532

"length": 42, # Column length.

533

"nullable": True or False, # Whether or not the column can accept a null value.

534

"ordinalPosition": 42, # The ordinal position of the column in the table.

535

"primaryKey": True or False, # Whether or not the column represents a primary key.

536

},

537

],

538

"tableName": "A String", # Table name.

},

],

},

],

},

"rejectlist": { # MySQL database structure # MySQL objects to exclude from the stream.

545

"mysqlDatabases": [ # Mysql databases on the server

546

{ # MySQL database.

547

"databaseName": "A String", # Database name.

548

"mysqlTables": [ # Tables in the database.

549

{ # MySQL table.

550

"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.

551

{ # MySQL Column.

552

"collation": "A String", # Column collation.

553

"columnName": "A String", # Column name.

554

"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html

555

"length": 42, # Column length.

556

"nullable": True or False, # Whether or not the column can accept a null value.

557

"ordinalPosition": 42, # The ordinal position of the column in the table.

558

"primaryKey": True or False, # Whether or not the column represents a primary key.

559

},

560

],

561

"tableName": "A String", # Table name.

},

],

},

],

},

},

"oracleSourceConfig": { # Oracle data source configuration # Oracle data source configuration

569

"allowlist": { # Oracle database structure. # Oracle objects to include in the stream.

570

"oracleSchemas": [ # Oracle schemas/databases in the database server.

571

{ # Oracle schema.

572

"oracleTables": [ # Tables in the schema.

573

{ # Oracle table.

574

"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.

575

{ # Oracle Column.

576

"columnName": "A String", # Column name.

577

"dataType": "A String", # The Oracle data type.

578

"encoding": "A String", # Column encoding.

579

"length": 42, # Column length.

580

"nullable": True or False, # Whether or not the column can accept a null value.

581

"ordinalPosition": 42, # The ordinal position of the column in the table.

582

"precision": 42, # Column precision.

583

"primaryKey": True or False, # Whether or not the column represents a primary key.

584

"scale": 42, # Column scale.

585

},

586

],

587

"tableName": "A String", # Table name.

588

},

589

],

590

"schemaName": "A String", # Schema name.

},

],

},

"rejectlist": { # Oracle database structure. # Oracle objects to exclude from the stream.

595

"oracleSchemas": [ # Oracle schemas/databases in the database server.

596

{ # Oracle schema.

597

"oracleTables": [ # Tables in the schema.

598

{ # Oracle table.

599

"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.

600

{ # Oracle Column.

601

"columnName": "A String", # Column name.

602

"dataType": "A String", # The Oracle data type.

603

"encoding": "A String", # Column encoding.

604

"length": 42, # Column length.

605

"nullable": True or False, # Whether or not the column can accept a null value.

606

"ordinalPosition": 42, # The ordinal position of the column in the table.

607

"precision": 42, # Column precision.

608

"primaryKey": True or False, # Whether or not the column represents a primary key.

609

"scale": 42, # Column scale.

610

},

611

],

612

"tableName": "A String", # Table name.

613

},

614

],

615

"schemaName": "A String", # Schema name.

},

],

},

},

"sourceConnectionProfileName": "A String", # Required. Source connection profile identifier.

621

},

622

"state": "A String", # The state of the stream.

623

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

}</pre>

</div>

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

629

<pre>Use this method to list streams in a project and location.

630

631

Args:

632

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

633

filter: string, Filter request.

634

orderBy: string, Order by fields for the result.

635

pageSize: integer, Maximum number of streams to return. If unspecified, at most 50 streams will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.

636

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

637

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

644

645

{

646

"nextPageToken": "A String", # A token, which can be sent as `page_token` to retrieve the next page. If this field is omitted, there are no subsequent pages.

647

"streams": [ # List of streams

648

{

649

"backfillAll": { # Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded. # Automatically backfill objects included in the stream source configuration. Specific objects can be excluded.

650

"mysqlExcludedObjects": { # MySQL database structure # MySQL data source objects to avoid backfilling.

651

"mysqlDatabases": [ # Mysql databases on the server

652

{ # MySQL database.

653

"databaseName": "A String", # Database name.

654

"mysqlTables": [ # Tables in the database.

655

{ # MySQL table.

656

"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.

657

{ # MySQL Column.

658

"collation": "A String", # Column collation.

659

"columnName": "A String", # Column name.

660

"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html

661

"length": 42, # Column length.

662

"nullable": True or False, # Whether or not the column can accept a null value.

663

"ordinalPosition": 42, # The ordinal position of the column in the table.

664

"primaryKey": True or False, # Whether or not the column represents a primary key.

665

},

666

],

667

"tableName": "A String", # Table name.

},

],

},

],

},

"oracleExcludedObjects": { # Oracle database structure. # Oracle data source objects to avoid backfilling.

674

"oracleSchemas": [ # Oracle schemas/databases in the database server.

675

{ # Oracle schema.

676

"oracleTables": [ # Tables in the schema.

677

{ # Oracle table.

678

"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.

679

{ # Oracle Column.

680

"columnName": "A String", # Column name.

681

"dataType": "A String", # The Oracle data type.

682

"encoding": "A String", # Column encoding.

683

"length": 42, # Column length.

684

"nullable": True or False, # Whether or not the column can accept a null value.

685

"ordinalPosition": 42, # The ordinal position of the column in the table.

686

"precision": 42, # Column precision.

687

"primaryKey": True or False, # Whether or not the column represents a primary key.

688

"scale": 42, # Column scale.

689

},

690

],

691

"tableName": "A String", # Table name.

692

},

693

],

694

"schemaName": "A String", # Schema name.

},

],

},

},

"backfillNone": { # Backfill strategy to disable automatic backfill for the Stream's objects. # Do not automatically backfill any objects.

700

},

701

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

yoshi-code-bot

5dcb723

2021-11-08 23:24:14 -0800

[diff] [blame]

702

"customerManagedEncryptionKey": "A String", # Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS.

yoshi-code-bot

12d387c

2021-10-26 00:24:32 -0700

[diff] [blame]

703

"destinationConfig": { # The configuration of the stream destination. # Required. Destination connection profile configuration.

704

"destinationConnectionProfileName": "A String", # Required. Destination connection profile identifier.

705

"gcsDestinationConfig": { # Google Cloud Storage destination configuration

706

"avroFileFormat": { # AVRO file format configuration. # AVRO file format configuration.

707

},

708

"fileRotationInterval": "A String", # The maximum duration for which new events are added before a file is closed and a new file is created.

709

"fileRotationMb": 42, # The maximum file size to be saved in the bucket.

710

"gcsFileFormat": "A String", # File format that data should be written in. Deprecated field (b/169501737) - use file_format instead.

711

"jsonFileFormat": { # JSON file format configuration. # JSON file format configuration.

712

"compression": "A String", # Compression of the loaded JSON file.

713

"schemaFileFormat": "A String", # The schema file format along JSON data files.

714

},

715

"path": "A String", # Path inside the Cloud Storage bucket to write data to.

716

},

717

},

718

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

719

"errors": [ # Output only. Errors on the Stream.

720

{ # Represent a user-facing Error.

721

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

722

"a_key": "A String",

723

},

724

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

725

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

726

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

727

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

728

},

729

],

730

"labels": { # Labels.

731

"a_key": "A String",

732

},

733

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

734

"sourceConfig": { # The configuration of the stream source. # Required. Source connection profile configuration.

735

"mysqlSourceConfig": { # MySQL source configuration # MySQL data source configuration

736

"allowlist": { # MySQL database structure # MySQL objects to retrieve from the source.

737

"mysqlDatabases": [ # Mysql databases on the server

738

{ # MySQL database.

739

"databaseName": "A String", # Database name.

740

"mysqlTables": [ # Tables in the database.

741

{ # MySQL table.

742

"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.

743

{ # MySQL Column.

744

"collation": "A String", # Column collation.

745

"columnName": "A String", # Column name.

746

"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html

747

"length": 42, # Column length.

748

"nullable": True or False, # Whether or not the column can accept a null value.

749

"ordinalPosition": 42, # The ordinal position of the column in the table.

750

"primaryKey": True or False, # Whether or not the column represents a primary key.

751

},

752

],

753

"tableName": "A String", # Table name.

},

],

},

],

},

"rejectlist": { # MySQL database structure # MySQL objects to exclude from the stream.

760

"mysqlDatabases": [ # Mysql databases on the server

761

{ # MySQL database.

762

"databaseName": "A String", # Database name.

763

"mysqlTables": [ # Tables in the database.

764

{ # MySQL table.

765

"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.

766

{ # MySQL Column.

767

"collation": "A String", # Column collation.

768

"columnName": "A String", # Column name.

769

"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html

770

"length": 42, # Column length.

771

"nullable": True or False, # Whether or not the column can accept a null value.

772

"ordinalPosition": 42, # The ordinal position of the column in the table.

773

"primaryKey": True or False, # Whether or not the column represents a primary key.

774

},

775

],

776

"tableName": "A String", # Table name.

},

],

},

],

},

},

"oracleSourceConfig": { # Oracle data source configuration # Oracle data source configuration

784

"allowlist": { # Oracle database structure. # Oracle objects to include in the stream.

785

"oracleSchemas": [ # Oracle schemas/databases in the database server.

786

{ # Oracle schema.

787

"oracleTables": [ # Tables in the schema.

788

{ # Oracle table.

789

"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.

790

{ # Oracle Column.

791

"columnName": "A String", # Column name.

792

"dataType": "A String", # The Oracle data type.

793

"encoding": "A String", # Column encoding.

794

"length": 42, # Column length.

795

"nullable": True or False, # Whether or not the column can accept a null value.

796

"ordinalPosition": 42, # The ordinal position of the column in the table.

797

"precision": 42, # Column precision.

798

"primaryKey": True or False, # Whether or not the column represents a primary key.

799

"scale": 42, # Column scale.

800

},

801

],

802

"tableName": "A String", # Table name.

803

},

804

],

805

"schemaName": "A String", # Schema name.

},

],

},

"rejectlist": { # Oracle database structure. # Oracle objects to exclude from the stream.

810

"oracleSchemas": [ # Oracle schemas/databases in the database server.

811

{ # Oracle schema.

812

"oracleTables": [ # Tables in the schema.

813

{ # Oracle table.

814

"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.

815

{ # Oracle Column.

816

"columnName": "A String", # Column name.

817

"dataType": "A String", # The Oracle data type.

818

"encoding": "A String", # Column encoding.

819

"length": 42, # Column length.

820

"nullable": True or False, # Whether or not the column can accept a null value.

821

"ordinalPosition": 42, # The ordinal position of the column in the table.

822

"precision": 42, # Column precision.

823

"primaryKey": True or False, # Whether or not the column represents a primary key.

824

"scale": 42, # Column scale.

825

},

826

],

827

"tableName": "A String", # Table name.

828

},

829

],

830

"schemaName": "A String", # Schema name.

},

],

},

},

"sourceConnectionProfileName": "A String", # Required. Source connection profile identifier.

836

},

837

"state": "A String", # The state of the stream.

838

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

839

},

840

],

841

"unreachable": [ # Locations that could not be reached.

"A String",

],

}</pre>

</div>

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

849

<pre>Retrieves the next page of results.

850

851

Args:

852

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

853

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

854

855

Returns:

856

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

857

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

</pre>

</div>

<code class="details" id="patch">patch(name, body=None, force=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</code>

863

<pre>Use this method to update the configuration of a stream.

Args:

body: object, The request body.

868

The object takes the form of:

869

870

{

871

"backfillAll": { # Backfill strategy to automatically backfill the Stream's objects. Specific objects can be excluded. # Automatically backfill objects included in the stream source configuration. Specific objects can be excluded.

872

"mysqlExcludedObjects": { # MySQL database structure # MySQL data source objects to avoid backfilling.

873

"mysqlDatabases": [ # Mysql databases on the server

874

{ # MySQL database.

875

"databaseName": "A String", # Database name.

876

"mysqlTables": [ # Tables in the database.

877

{ # MySQL table.

878

"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.

879

{ # MySQL Column.

880

"collation": "A String", # Column collation.

881

"columnName": "A String", # Column name.

882

"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html

883

"length": 42, # Column length.

884

"nullable": True or False, # Whether or not the column can accept a null value.

885

"ordinalPosition": 42, # The ordinal position of the column in the table.

886

"primaryKey": True or False, # Whether or not the column represents a primary key.

887

},

888

],

889

"tableName": "A String", # Table name.

},

],

},

],

},

"oracleExcludedObjects": { # Oracle database structure. # Oracle data source objects to avoid backfilling.

896

"oracleSchemas": [ # Oracle schemas/databases in the database server.

897

{ # Oracle schema.

898

"oracleTables": [ # Tables in the schema.

899

{ # Oracle table.

900

"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.

901

{ # Oracle Column.

902

"columnName": "A String", # Column name.

903

"dataType": "A String", # The Oracle data type.

904

"encoding": "A String", # Column encoding.

905

"length": 42, # Column length.

906

"nullable": True or False, # Whether or not the column can accept a null value.

907

"ordinalPosition": 42, # The ordinal position of the column in the table.

908

"precision": 42, # Column precision.

909

"primaryKey": True or False, # Whether or not the column represents a primary key.

910

"scale": 42, # Column scale.

911

},

912

],

913

"tableName": "A String", # Table name.

914

},

915

],

916

"schemaName": "A String", # Schema name.

},

],

},

},

"backfillNone": { # Backfill strategy to disable automatic backfill for the Stream's objects. # Do not automatically backfill any objects.

922

},

923

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

yoshi-code-bot

5dcb723

2021-11-08 23:24:14 -0800

[diff] [blame]

924

"customerManagedEncryptionKey": "A String", # Immutable. A reference to a KMS encryption key. If provided, it will be used to encrypt the data. If left blank, data will be encrypted using an internal Stream-specific encryption key provisioned through KMS.

yoshi-code-bot

12d387c

2021-10-26 00:24:32 -0700

[diff] [blame]

925

"destinationConfig": { # The configuration of the stream destination. # Required. Destination connection profile configuration.

926

"destinationConnectionProfileName": "A String", # Required. Destination connection profile identifier.

927

"gcsDestinationConfig": { # Google Cloud Storage destination configuration

928

"avroFileFormat": { # AVRO file format configuration. # AVRO file format configuration.

929

},

930

"fileRotationInterval": "A String", # The maximum duration for which new events are added before a file is closed and a new file is created.

931

"fileRotationMb": 42, # The maximum file size to be saved in the bucket.

932

"gcsFileFormat": "A String", # File format that data should be written in. Deprecated field (b/169501737) - use file_format instead.

933

"jsonFileFormat": { # JSON file format configuration. # JSON file format configuration.

934

"compression": "A String", # Compression of the loaded JSON file.

935

"schemaFileFormat": "A String", # The schema file format along JSON data files.

936

},

937

"path": "A String", # Path inside the Cloud Storage bucket to write data to.

938

},

939

},

940

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

941

"errors": [ # Output only. Errors on the Stream.

942

{ # Represent a user-facing Error.

943

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

944

"a_key": "A String",

945

},

946

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

947

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

948

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

949

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

950

},

951

],

952

"labels": { # Labels.

953

"a_key": "A String",

954

},

955

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

956

"sourceConfig": { # The configuration of the stream source. # Required. Source connection profile configuration.

957

"mysqlSourceConfig": { # MySQL source configuration # MySQL data source configuration

958

"allowlist": { # MySQL database structure # MySQL objects to retrieve from the source.

959

"mysqlDatabases": [ # Mysql databases on the server

960

{ # MySQL database.

961

"databaseName": "A String", # Database name.

962

"mysqlTables": [ # Tables in the database.

963

{ # MySQL table.

964

"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.

965

{ # MySQL Column.

966

"collation": "A String", # Column collation.

967

"columnName": "A String", # Column name.

968

"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html

969

"length": 42, # Column length.

970

"nullable": True or False, # Whether or not the column can accept a null value.

971

"ordinalPosition": 42, # The ordinal position of the column in the table.

972

"primaryKey": True or False, # Whether or not the column represents a primary key.

973

},

974

],

975

"tableName": "A String", # Table name.

},

],

},

],

},

"rejectlist": { # MySQL database structure # MySQL objects to exclude from the stream.

982

"mysqlDatabases": [ # Mysql databases on the server

983

{ # MySQL database.

984

"databaseName": "A String", # Database name.

985

"mysqlTables": [ # Tables in the database.

986

{ # MySQL table.

987

"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.

988

{ # MySQL Column.

989

"collation": "A String", # Column collation.

990

"columnName": "A String", # Column name.

991

"dataType": "A String", # The MySQL data type. Full data types list can be found here: https://dev.mysql.com/doc/refman/8.0/en/data-types.html

992

"length": 42, # Column length.

993

"nullable": True or False, # Whether or not the column can accept a null value.

994

"ordinalPosition": 42, # The ordinal position of the column in the table.

995

"primaryKey": True or False, # Whether or not the column represents a primary key.

996

},

997

],

998

"tableName": "A String", # Table name.

},

],

},

],

},

},

"oracleSourceConfig": { # Oracle data source configuration # Oracle data source configuration

1006

"allowlist": { # Oracle database structure. # Oracle objects to include in the stream.

1007

"oracleSchemas": [ # Oracle schemas/databases in the database server.

1008

{ # Oracle schema.

1009

"oracleTables": [ # Tables in the schema.

1010

{ # Oracle table.

1011

"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.

1012

{ # Oracle Column.

1013

"columnName": "A String", # Column name.

1014

"dataType": "A String", # The Oracle data type.

1015

"encoding": "A String", # Column encoding.

1016

"length": 42, # Column length.

1017

"nullable": True or False, # Whether or not the column can accept a null value.

1018

"ordinalPosition": 42, # The ordinal position of the column in the table.

1019

"precision": 42, # Column precision.

1020

"primaryKey": True or False, # Whether or not the column represents a primary key.

1021

"scale": 42, # Column scale.

1022

},

1023

],

1024

"tableName": "A String", # Table name.

1025

},

1026

],

1027

"schemaName": "A String", # Schema name.

},

],

},

"rejectlist": { # Oracle database structure. # Oracle objects to exclude from the stream.

1032

"oracleSchemas": [ # Oracle schemas/databases in the database server.

1033

{ # Oracle schema.

1034

"oracleTables": [ # Tables in the schema.

1035

{ # Oracle table.

1036

"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.

1037

{ # Oracle Column.

1038

"columnName": "A String", # Column name.

1039

"dataType": "A String", # The Oracle data type.

1040

"encoding": "A String", # Column encoding.

1041

"length": 42, # Column length.

1042

"nullable": True or False, # Whether or not the column can accept a null value.

1043

"ordinalPosition": 42, # The ordinal position of the column in the table.

1044

"precision": 42, # Column precision.

1045

"primaryKey": True or False, # Whether or not the column represents a primary key.

1046

"scale": 42, # Column scale.

1047

},

1048

],

1049

"tableName": "A String", # Table name.

1050

},

1051

],

1052

"schemaName": "A String", # Schema name.

},

],

},

},

"sourceConnectionProfileName": "A String", # Required. Source connection profile identifier.

1058

},

1059

"state": "A String", # The state of the stream.

1060

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

1061

}

1062

1063

force: boolean, Optional. Execute the update without validating it.

1064

requestId: string, Optional. A request ID to identify requests. Specify a unique request ID so that if you must retry your request, the server will know to ignore the request if it has already been completed. The server will guarantee that for at least 60 minutes since the first request. For example, consider a situation where you make an initial request and the request times out. If you make the request again with the same request ID, the server can check if original operation with the same request ID was received, and if so, will ignore the second request. This prevents clients from accidentally creating duplicate commitments. The request ID must be a valid UUID with the exception that zero UUID is not supported (00000000-0000-0000-0000-000000000000).

1065

updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the stream resource by the update. The fields specified in the update_mask are relative to the resource, not the full request. A field will be overwritten if it is in the mask. If the user does not provide a mask then all fields will be overwritten.

1066

validateOnly: boolean, Optional. Only validate the stream with the changes, without actually updating it. The default is false.

1067

x__xgafv: string, V1 error format.

Allowed values

1 - v1 error format

2 - v2 error format

Returns:

An object of the form:

1074

1075

{ # This resource represents a long-running operation that is the result of a network API call.

1076

"done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available.

1077

"error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation.

1078

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

1079

"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.

1080

{

1081

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

1082

},

1083

],

1084

"message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

1085

},

1086

"metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any.

1087

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

1088

},

1089

"name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`.

1090

"response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`.

1091

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

},

}</pre>

</div>

</body></html>