1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
|
<html><body>
<style>
body, h1, h2, h3, div, span, p, pre, a {
margin: 0;
padding: 0;
border: 0;
font-weight: inherit;
font-style: inherit;
font-size: 100%;
font-family: inherit;
vertical-align: baseline;
}
body {
font-size: 13px;
padding: 1em;
}
h1 {
font-size: 26px;
margin-bottom: 1em;
}
h2 {
font-size: 24px;
margin-bottom: 1em;
}
h3 {
font-size: 20px;
margin-bottom: 1em;
margin-top: 1em;
}
pre, code {
line-height: 1.5;
font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
}
pre {
margin-top: 0.5em;
}
h1, h2, h3, p {
font-family: Arial, sans serif;
}
h1, h2, h3 {
border-bottom: solid #CCC 1px;
}
.toc_element {
margin-top: 0.5em;
}
.firstline {
margin-left: 2 em;
}
.method {
margin-top: 1em;
border: solid 1px #CCC;
padding: 1em;
background: #EEE;
}
.details {
font-weight: bold;
font-size: 14px;
}
</style>
<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.connectionProfiles.html">connectionProfiles</a></h1>
<h2>Instance Methods</h2>
<p class="toc_element">
<code><a href="#close">close()</a></code></p>
<p class="firstline">Close httplib2 connections.</p>
<p class="toc_element">
<code><a href="#create">create(parent, body=None, connectionProfileId=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Use this method to create a connection profile in a project and location.</p>
<p class="toc_element">
<code><a href="#delete">delete(name, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Use this method to delete a connection profile..</p>
<p class="toc_element">
<code><a href="#discover">discover(parent, body=None, x__xgafv=None)</a></code></p>
<p class="firstline">Use this method to discover a connection profile. The discover API call exposes the data objects and metadata belonging to the profile. Typically, a request returns children data objects under a parent data object that's optionally supplied in the request.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Use this method to get details about a connection profile.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Use this method to list connection profiles created in a project and location.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
<p class="toc_element">
<code><a href="#patch">patch(name, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</a></code></p>
<p class="firstline">Use this method to update the parameters of a connection profile.</p>
<h3>Method Details</h3>
<div class="method">
<code class="details" id="close">close()</code>
<pre>Close httplib2 connections.</pre>
</div>
<div class="method">
<code class="details" id="create">create(parent, body=None, connectionProfileId=None, requestId=None, x__xgafv=None)</code>
<pre>Use this method to create a connection profile in a project and location.
Args:
parent: string, Required. The parent that owns the collection of ConnectionProfiles. (required)
body: object, The request body.
The object takes the form of:
{
"createTime": "A String", # Output only. The create time of the resource.
"displayName": "A String", # Required. Display name.
"forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity.
"hostname": "A String", # Required. Hostname for the SSH tunnel.
"password": "A String", # Input only. SSH password.
"port": 42, # Port for the SSH tunnel, default value is 22.
"privateKey": "A String", # Input only. SSH private key.
"username": "A String", # Required. Username for the SSH tunnel.
},
"gcsProfile": { # Cloud Storage bucket profile. # Cloud Storage ConnectionProfile configuration.
"bucketName": "A String", # Required. The full project and resource path for Cloud Storage bucket including the name.
"rootPath": "A String", # The root path inside the Cloud Storage bucket.
},
"labels": { # Labels.
"a_key": "A String",
},
"mysqlProfile": { # MySQL database profile. # MySQL ConnectionProfile configuration.
"hostname": "A String", # Required. Hostname for the MySQL connection.
"password": "A String", # Required. Input only. Password for the MySQL connection.
"port": 42, # Port for the MySQL connection, default value is 3306.
"sslConfig": { # MySQL SSL configuration information. # SSL configuration for the MySQL connection.
"caCertificate": "A String", # Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.
"caCertificateSet": True or False, # Output only. Indicates whether the ca_certificate field is set.
"clientCertificate": "A String", # Input only. PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the 'client_key' and the 'ca_certificate' fields are mandatory.
"clientCertificateSet": True or False, # Output only. Indicates whether the client_certificate field is set.
"clientKey": "A String", # Input only. PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' and the 'ca_certificate' fields are mandatory.
"clientKeySet": True or False, # Output only. Indicates whether the client_key field is set.
},
"username": "A String", # Required. Username for the MySQL connection.
},
"name": "A String", # Output only. The resource's name.
"noConnectivity": { # No connectivity settings. # No connectivity option chosen.
},
"oracleProfile": { # Oracle database profile. # Oracle ConnectionProfile configuration.
"connectionAttributes": { # Connection string attributes
"a_key": "A String",
},
"databaseService": "A String", # Required. Database for the Oracle connection.
"hostname": "A String", # Required. Hostname for the Oracle connection.
"password": "A String", # Required. Password for the Oracle connection.
"port": 42, # Port for the Oracle connection, default value is 1521.
"username": "A String", # Required. Username for the Oracle connection.
},
"privateConnectivity": { # Private Connectivity # Private connectivity.
"privateConnectionName": "A String",
},
"staticServiceIpConnectivity": { # Static IP address connectivity. # Static Service IP connectivity.
},
"updateTime": "A String", # Output only. The update time of the resource.
}
connectionProfileId: string, Required. The connection profile identifier.
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).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="delete">delete(name, requestId=None, x__xgafv=None)</code>
<pre>Use this method to delete a connection profile..
Args:
name: string, Required. The name of the connection profile resource to delete. (required)
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).
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
<div class="method">
<code class="details" id="discover">discover(parent, body=None, x__xgafv=None)</code>
<pre>Use this method to discover a connection profile. The discover API call exposes the data objects and metadata belonging to the profile. Typically, a request returns children data objects under a parent data object that's optionally supplied in the request.
Args:
parent: string, Required. The parent resource of the ConnectionProfile type. Must be in the format `projects/*/locations/*`. (required)
body: object, The request body.
The object takes the form of:
{ # Request message for 'discover' ConnectionProfile request.
"connectionProfile": { # An ad-hoc ConnectionProfile configuration.
"createTime": "A String", # Output only. The create time of the resource.
"displayName": "A String", # Required. Display name.
"forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity.
"hostname": "A String", # Required. Hostname for the SSH tunnel.
"password": "A String", # Input only. SSH password.
"port": 42, # Port for the SSH tunnel, default value is 22.
"privateKey": "A String", # Input only. SSH private key.
"username": "A String", # Required. Username for the SSH tunnel.
},
"gcsProfile": { # Cloud Storage bucket profile. # Cloud Storage ConnectionProfile configuration.
"bucketName": "A String", # Required. The full project and resource path for Cloud Storage bucket including the name.
"rootPath": "A String", # The root path inside the Cloud Storage bucket.
},
"labels": { # Labels.
"a_key": "A String",
},
"mysqlProfile": { # MySQL database profile. # MySQL ConnectionProfile configuration.
"hostname": "A String", # Required. Hostname for the MySQL connection.
"password": "A String", # Required. Input only. Password for the MySQL connection.
"port": 42, # Port for the MySQL connection, default value is 3306.
"sslConfig": { # MySQL SSL configuration information. # SSL configuration for the MySQL connection.
"caCertificate": "A String", # Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.
"caCertificateSet": True or False, # Output only. Indicates whether the ca_certificate field is set.
"clientCertificate": "A String", # Input only. PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the 'client_key' and the 'ca_certificate' fields are mandatory.
"clientCertificateSet": True or False, # Output only. Indicates whether the client_certificate field is set.
"clientKey": "A String", # Input only. PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' and the 'ca_certificate' fields are mandatory.
"clientKeySet": True or False, # Output only. Indicates whether the client_key field is set.
},
"username": "A String", # Required. Username for the MySQL connection.
},
"name": "A String", # Output only. The resource's name.
"noConnectivity": { # No connectivity settings. # No connectivity option chosen.
},
"oracleProfile": { # Oracle database profile. # Oracle ConnectionProfile configuration.
"connectionAttributes": { # Connection string attributes
"a_key": "A String",
},
"databaseService": "A String", # Required. Database for the Oracle connection.
"hostname": "A String", # Required. Hostname for the Oracle connection.
"password": "A String", # Required. Password for the Oracle connection.
"port": 42, # Port for the Oracle connection, default value is 1521.
"username": "A String", # Required. Username for the Oracle connection.
},
"privateConnectivity": { # Private Connectivity # Private connectivity.
"privateConnectionName": "A String",
},
"staticServiceIpConnectivity": { # Static IP address connectivity. # Static Service IP connectivity.
},
"updateTime": "A String", # Output only. The update time of the resource.
},
"connectionProfileName": "A String", # A reference to an existing ConnectionProfile.
"mysqlRdbms": { # MySQL database structure # MySQL RDBMS to enrich with child data objects and metadata.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"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
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
"oracleRdbms": { # Oracle database structure. # Oracle RDBMS to enrich with child data objects and metadata.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
"recursionDepth": 42, # The number of hierarchy levels below the current level to be retrieved.
"recursive": True or False, # Whether to retrieve the full hierarchy of data objects (TRUE) or only the current level (FALSE).
}
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"mysqlRdbms": { # MySQL database structure # Enriched MySQL RDBMS object.
"mysqlDatabases": [ # Mysql databases on the server
{ # MySQL database.
"databaseName": "A String", # Database name.
"mysqlTables": [ # Tables in the database.
{ # MySQL table.
"mysqlColumns": [ # MySQL columns in the database. When unspecified as part of include/exclude lists, includes/excludes everything.
{ # MySQL Column.
"collation": "A String", # Column collation.
"columnName": "A String", # Column name.
"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
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"primaryKey": True or False, # Whether or not the column represents a primary key.
},
],
"tableName": "A String", # Table name.
},
],
},
],
},
"oracleRdbms": { # Oracle database structure. # Enriched Oracle RDBMS object.
"oracleSchemas": [ # Oracle schemas/databases in the database server.
{ # Oracle schema.
"oracleTables": [ # Tables in the schema.
{ # Oracle table.
"oracleColumns": [ # Oracle columns in the schema. When unspecified as part of inclue/exclude lists, includes/excludes everything.
{ # Oracle Column.
"columnName": "A String", # Column name.
"dataType": "A String", # The Oracle data type.
"encoding": "A String", # Column encoding.
"length": 42, # Column length.
"nullable": True or False, # Whether or not the column can accept a null value.
"ordinalPosition": 42, # The ordinal position of the column in the table.
"precision": 42, # Column precision.
"primaryKey": True or False, # Whether or not the column represents a primary key.
"scale": 42, # Column scale.
},
],
"tableName": "A String", # Table name.
},
],
"schemaName": "A String", # Schema name.
},
],
},
}</pre>
</div>
<div class="method">
<code class="details" id="get">get(name, x__xgafv=None)</code>
<pre>Use this method to get details about a connection profile.
Args:
name: string, Required. The name of the connection profile resource to get. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"createTime": "A String", # Output only. The create time of the resource.
"displayName": "A String", # Required. Display name.
"forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity.
"hostname": "A String", # Required. Hostname for the SSH tunnel.
"password": "A String", # Input only. SSH password.
"port": 42, # Port for the SSH tunnel, default value is 22.
"privateKey": "A String", # Input only. SSH private key.
"username": "A String", # Required. Username for the SSH tunnel.
},
"gcsProfile": { # Cloud Storage bucket profile. # Cloud Storage ConnectionProfile configuration.
"bucketName": "A String", # Required. The full project and resource path for Cloud Storage bucket including the name.
"rootPath": "A String", # The root path inside the Cloud Storage bucket.
},
"labels": { # Labels.
"a_key": "A String",
},
"mysqlProfile": { # MySQL database profile. # MySQL ConnectionProfile configuration.
"hostname": "A String", # Required. Hostname for the MySQL connection.
"password": "A String", # Required. Input only. Password for the MySQL connection.
"port": 42, # Port for the MySQL connection, default value is 3306.
"sslConfig": { # MySQL SSL configuration information. # SSL configuration for the MySQL connection.
"caCertificate": "A String", # Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.
"caCertificateSet": True or False, # Output only. Indicates whether the ca_certificate field is set.
"clientCertificate": "A String", # Input only. PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the 'client_key' and the 'ca_certificate' fields are mandatory.
"clientCertificateSet": True or False, # Output only. Indicates whether the client_certificate field is set.
"clientKey": "A String", # Input only. PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' and the 'ca_certificate' fields are mandatory.
"clientKeySet": True or False, # Output only. Indicates whether the client_key field is set.
},
"username": "A String", # Required. Username for the MySQL connection.
},
"name": "A String", # Output only. The resource's name.
"noConnectivity": { # No connectivity settings. # No connectivity option chosen.
},
"oracleProfile": { # Oracle database profile. # Oracle ConnectionProfile configuration.
"connectionAttributes": { # Connection string attributes
"a_key": "A String",
},
"databaseService": "A String", # Required. Database for the Oracle connection.
"hostname": "A String", # Required. Hostname for the Oracle connection.
"password": "A String", # Required. Password for the Oracle connection.
"port": 42, # Port for the Oracle connection, default value is 1521.
"username": "A String", # Required. Username for the Oracle connection.
},
"privateConnectivity": { # Private Connectivity # Private connectivity.
"privateConnectionName": "A String",
},
"staticServiceIpConnectivity": { # Static IP address connectivity. # Static Service IP connectivity.
},
"updateTime": "A String", # Output only. The update time of the resource.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, orderBy=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Use this method to list connection profiles created in a project and location.
Args:
parent: string, Required. The parent that owns the collection of connection profiles. (required)
filter: string, Filter request.
orderBy: string, Order by fields for the result.
pageSize: integer, Maximum number of connection profiles to return. If unspecified, at most 50 connection profiles will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Page token received from a previous `ListConnectionProfiles` call. Provide this to retrieve the subsequent page. When paginating, all other parameters provided to `ListConnectionProfiles` must match the call that provided the page token.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{
"connectionProfiles": [ # List of connection profiles.
{
"createTime": "A String", # Output only. The create time of the resource.
"displayName": "A String", # Required. Display name.
"forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity.
"hostname": "A String", # Required. Hostname for the SSH tunnel.
"password": "A String", # Input only. SSH password.
"port": 42, # Port for the SSH tunnel, default value is 22.
"privateKey": "A String", # Input only. SSH private key.
"username": "A String", # Required. Username for the SSH tunnel.
},
"gcsProfile": { # Cloud Storage bucket profile. # Cloud Storage ConnectionProfile configuration.
"bucketName": "A String", # Required. The full project and resource path for Cloud Storage bucket including the name.
"rootPath": "A String", # The root path inside the Cloud Storage bucket.
},
"labels": { # Labels.
"a_key": "A String",
},
"mysqlProfile": { # MySQL database profile. # MySQL ConnectionProfile configuration.
"hostname": "A String", # Required. Hostname for the MySQL connection.
"password": "A String", # Required. Input only. Password for the MySQL connection.
"port": 42, # Port for the MySQL connection, default value is 3306.
"sslConfig": { # MySQL SSL configuration information. # SSL configuration for the MySQL connection.
"caCertificate": "A String", # Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.
"caCertificateSet": True or False, # Output only. Indicates whether the ca_certificate field is set.
"clientCertificate": "A String", # Input only. PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the 'client_key' and the 'ca_certificate' fields are mandatory.
"clientCertificateSet": True or False, # Output only. Indicates whether the client_certificate field is set.
"clientKey": "A String", # Input only. PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' and the 'ca_certificate' fields are mandatory.
"clientKeySet": True or False, # Output only. Indicates whether the client_key field is set.
},
"username": "A String", # Required. Username for the MySQL connection.
},
"name": "A String", # Output only. The resource's name.
"noConnectivity": { # No connectivity settings. # No connectivity option chosen.
},
"oracleProfile": { # Oracle database profile. # Oracle ConnectionProfile configuration.
"connectionAttributes": { # Connection string attributes
"a_key": "A String",
},
"databaseService": "A String", # Required. Database for the Oracle connection.
"hostname": "A String", # Required. Hostname for the Oracle connection.
"password": "A String", # Required. Password for the Oracle connection.
"port": 42, # Port for the Oracle connection, default value is 1521.
"username": "A String", # Required. Username for the Oracle connection.
},
"privateConnectivity": { # Private Connectivity # Private connectivity.
"privateConnectionName": "A String",
},
"staticServiceIpConnectivity": { # Static IP address connectivity. # Static Service IP connectivity.
},
"updateTime": "A String", # Output only. The update time of the resource.
},
],
"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.
"unreachable": [ # Locations that could not be reached.
"A String",
],
}</pre>
</div>
<div class="method">
<code class="details" id="list_next">list_next()</code>
<pre>Retrieves the next page of results.
Args:
previous_request: The request for the previous page. (required)
previous_response: The response from the request for the previous page. (required)
Returns:
A request object that you can call 'execute()' on to request the next
page. Returns None if there are no more items in the collection.
</pre>
</div>
<div class="method">
<code class="details" id="patch">patch(name, body=None, requestId=None, updateMask=None, validateOnly=None, x__xgafv=None)</code>
<pre>Use this method to update the parameters of a connection profile.
Args:
name: string, Output only. The resource's name. (required)
body: object, The request body.
The object takes the form of:
{
"createTime": "A String", # Output only. The create time of the resource.
"displayName": "A String", # Required. Display name.
"forwardSshConnectivity": { # Forward SSH Tunnel connectivity. # Forward SSH tunnel connectivity.
"hostname": "A String", # Required. Hostname for the SSH tunnel.
"password": "A String", # Input only. SSH password.
"port": 42, # Port for the SSH tunnel, default value is 22.
"privateKey": "A String", # Input only. SSH private key.
"username": "A String", # Required. Username for the SSH tunnel.
},
"gcsProfile": { # Cloud Storage bucket profile. # Cloud Storage ConnectionProfile configuration.
"bucketName": "A String", # Required. The full project and resource path for Cloud Storage bucket including the name.
"rootPath": "A String", # The root path inside the Cloud Storage bucket.
},
"labels": { # Labels.
"a_key": "A String",
},
"mysqlProfile": { # MySQL database profile. # MySQL ConnectionProfile configuration.
"hostname": "A String", # Required. Hostname for the MySQL connection.
"password": "A String", # Required. Input only. Password for the MySQL connection.
"port": 42, # Port for the MySQL connection, default value is 3306.
"sslConfig": { # MySQL SSL configuration information. # SSL configuration for the MySQL connection.
"caCertificate": "A String", # Input only. PEM-encoded certificate of the CA that signed the source database server's certificate.
"caCertificateSet": True or False, # Output only. Indicates whether the ca_certificate field is set.
"clientCertificate": "A String", # Input only. PEM-encoded certificate that will be used by the replica to authenticate against the source database server. If this field is used then the 'client_key' and the 'ca_certificate' fields are mandatory.
"clientCertificateSet": True or False, # Output only. Indicates whether the client_certificate field is set.
"clientKey": "A String", # Input only. PEM-encoded private key associated with the Client Certificate. If this field is used then the 'client_certificate' and the 'ca_certificate' fields are mandatory.
"clientKeySet": True or False, # Output only. Indicates whether the client_key field is set.
},
"username": "A String", # Required. Username for the MySQL connection.
},
"name": "A String", # Output only. The resource's name.
"noConnectivity": { # No connectivity settings. # No connectivity option chosen.
},
"oracleProfile": { # Oracle database profile. # Oracle ConnectionProfile configuration.
"connectionAttributes": { # Connection string attributes
"a_key": "A String",
},
"databaseService": "A String", # Required. Database for the Oracle connection.
"hostname": "A String", # Required. Hostname for the Oracle connection.
"password": "A String", # Required. Password for the Oracle connection.
"port": 42, # Port for the Oracle connection, default value is 1521.
"username": "A String", # Required. Username for the Oracle connection.
},
"privateConnectivity": { # Private Connectivity # Private connectivity.
"privateConnectionName": "A String",
},
"staticServiceIpConnectivity": { # Static IP address connectivity. # Static Service IP connectivity.
},
"updateTime": "A String", # Output only. The update time of the resource.
}
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).
updateMask: string, Optional. Field mask is used to specify the fields to be overwritten in the ConnectionProfile 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.
validateOnly: boolean, Optional. Only validate the connection profile, but do not update any resources. The default is false.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # This resource represents a long-running operation that is the result of a network API call.
"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.
"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.
"code": 42, # The status code, which should be an enum value of google.rpc.Code.
"details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use.
{
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
],
"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.
},
"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.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
"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}`.
"response": { # The normal, successful response of the operation. 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`.
"a_key": "", # Properties of the object. Contains field @type with type URL.
},
}</pre>
</div>
</body></html>
|
