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
|
<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="oracledatabase_v1.html">Oracle Database@Google Cloud API</a> . <a href="oracledatabase_v1.projects.html">projects</a> . <a href="oracledatabase_v1.projects.locations.html">locations</a> . <a href="oracledatabase_v1.projects.locations.dbSystems.html">dbSystems</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, dbSystemId=None, requestId=None, x__xgafv=None)</a></code></p>
<p class="firstline">Creates a new DbSystem in a given 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">Deletes a single DbSystem.</p>
<p class="toc_element">
<code><a href="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single DbSystem.</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">Lists all the DbSystems for the given 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>
<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, dbSystemId=None, requestId=None, x__xgafv=None)</code>
<pre>Creates a new DbSystem in a given project and location.
Args:
parent: string, Required. The value for parent of the DbSystem in the following format: projects/{project}/locations/{location}. (required)
body: object, The request body.
The object takes the form of:
{ # Details of the DbSystem (BaseDB) resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystem/
"createTime": "A String", # Output only. The date and time that the DbSystem was created.
"displayName": "A String", # Required. The display name for the System db. The name does not have to be unique within your project.
"entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the DbSystem
"gcpOracleZone": "A String", # Optional. The GCP Oracle zone where Oracle DbSystem is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.
"labels": { # Optional. The labels or tags associated with the DbSystem.
"a_key": "A String",
},
"name": "A String", # Identifier. The name of the DbSystem resource in the following format: projects/{project}/locations/{region}/dbSystems/{db_system}
"ociUrl": "A String", # Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
"odbNetwork": "A String", # Optional. The name of the OdbNetwork associated with the DbSystem. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.
"odbSubnet": "A String", # Required. The name of the OdbSubnet associated with the DbSystem for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
"properties": { # The properties of a DbSystem. # Optional. The properties of the DbSystem.
"computeCount": 42, # Required. The number of CPU cores to enable for the DbSystem.
"computeModel": "A String", # Optional. The compute model of the DbSystem.
"dataCollectionOptions": { # Data collection options for DbSystem. # Optional. Data collection options for diagnostics.
"isDiagnosticsEventsEnabled": True or False, # Optional. Indicates whether to enable data collection for diagnostics.
"isIncidentLogsEnabled": True or False, # Optional. Indicates whether to enable incident logs and trace collection.
},
"dataStorageSizeGb": 42, # Optional. The data storage size in GB that is currently available to DbSystems.
"databaseEdition": "A String", # Required. The database edition of the DbSystem.
"dbHome": { # Details of the Database Home resource. # Optional. Details for creating a Database Home.
"database": { # Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/ # Required. The Database resource.
"adminPassword": "A String", # Required. The password for the default ADMIN user.
"characterSet": "A String", # Optional. The character set for the database. The default is AL32UTF8.
"createTime": "A String", # Output only. The date and time that the Database was created.
"databaseId": "A String", # Optional. The database ID of the Database.
"dbHomeName": "A String", # Optional. The name of the DbHome resource associated with the Database.
"dbName": "A String", # Optional. The database name. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
"dbUniqueName": "A String", # Optional. The DB_UNIQUE_NAME of the Oracle Database being backed up.
"gcpOracleZone": "A String", # Output only. The GCP Oracle zone where the Database is created.
"name": "A String", # Identifier. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}
"ncharacterSet": "A String", # Optional. The national character set for the database. The default is AL16UTF16.
"ociUrl": "A String", # Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
"opsInsightsStatus": "A String", # Output only. The Status of Operations Insights for this Database.
"properties": { # The properties of a Database. # Optional. The properties of the Database.
"databaseManagementConfig": { # The configuration of the Database Management service. # Output only. The Database Management config.
"managementState": "A String", # Output only. The status of the Database Management service.
"managementType": "A String", # Output only. The Database Management type.
},
"dbBackupConfig": { # Backup Options for the Database. # Optional. Backup options for the Database.
"autoBackupEnabled": True or False, # Optional. If set to true, enables automatic backups on the database.
"autoFullBackupDay": "A String", # Optional. The day of the week on which the full backup should be performed on the database. If no value is provided, it will default to Sunday.
"autoFullBackupWindow": "A String", # Optional. The window in which the full backup should be performed on the database. If no value is provided, the default is anytime.
"autoIncrementalBackupWindow": "A String", # Optional. The window in which the incremental backup should be performed on the database. If no value is provided, the default is anytime except the auto full backup day.
"backupDeletionPolicy": "A String", # Optional. This defines when the backups will be deleted after Database termination.
"backupDestinationDetails": [ # Optional. Details of the database backup destinations.
{ # The details of the database backup destination.
"type": "A String", # Optional. The type of the database backup destination.
},
],
"retentionPeriodDays": 42, # Optional. The number of days an automatic backup is retained before being automatically deleted. This value determines the earliest point in time to which a database can be restored. Min: 1, Max: 60.
},
"dbVersion": "A String", # Required. The Oracle Database version.
"state": "A String", # Output only. State of the Database.
},
"tdeWalletPassword": "A String", # Optional. The TDE wallet password for the database.
},
"dbVersion": "A String", # Required. A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.
"displayName": "A String", # Optional. The display name for the Database Home. The name does not have to be unique within your project.
"isUnifiedAuditingEnabled": True or False, # Optional. Whether unified auditing is enabled for the Database Home.
},
"dbSystemOptions": { # Details of the DbSystem Options. # Optional. The options for the DbSystem.
"storageManagement": "A String", # Optional. The storage option used in DB system.
},
"domain": "A String", # Optional. The host domain name of the DbSystem.
"hostname": "A String", # Output only. The hostname of the DbSystem.
"hostnamePrefix": "A String", # Optional. Prefix for DB System host names.
"initialDataStorageSizeGb": 42, # Required. The initial data storage size in GB.
"licenseModel": "A String", # Required. The license model of the DbSystem.
"lifecycleState": "A String", # Output only. State of the DbSystem.
"memorySizeGb": 42, # Optional. The memory size in GB.
"nodeCount": 42, # Optional. The number of nodes in the DbSystem.
"ocid": "A String", # Output only. OCID of the DbSystem.
"privateIp": "A String", # Optional. The private IP address of the DbSystem.
"recoStorageSizeGb": 42, # Optional. The reco/redo storage size in GB.
"shape": "A String", # Required. Shape of DB System.
"sshPublicKeys": [ # Required. SSH public keys to be stored with the DbSystem.
"A String",
],
"timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Optional. Time zone of the DbSystem.
"id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
"version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
},
}
dbSystemId: string, Required. The ID of the DbSystem to create. This value is restricted to (^[a-z]([a-z0-9-]{0,61}[a-z0-9])?$) and must be a maximum of 63 characters in length. The value must start with a letter and end with a letter or a number.
requestId: string, Optional. An optional 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>Deletes a single DbSystem.
Args:
name: string, Required. The name of the DbSystem in the following format: projects/{project}/locations/{location}/dbSystems/{db_system}. (required)
requestId: string, Optional. An optional ID to identify the request. This value is used to identify duplicate requests. If you make a request with the same request ID and the original request is still in progress or completed, the server ignores 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="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single DbSystem.
Args:
name: string, Required. The name of the DbSystem in the following format: projects/{project}/locations/{location}/dbSystems/{db_system}. (required)
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # Details of the DbSystem (BaseDB) resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystem/
"createTime": "A String", # Output only. The date and time that the DbSystem was created.
"displayName": "A String", # Required. The display name for the System db. The name does not have to be unique within your project.
"entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the DbSystem
"gcpOracleZone": "A String", # Optional. The GCP Oracle zone where Oracle DbSystem is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.
"labels": { # Optional. The labels or tags associated with the DbSystem.
"a_key": "A String",
},
"name": "A String", # Identifier. The name of the DbSystem resource in the following format: projects/{project}/locations/{region}/dbSystems/{db_system}
"ociUrl": "A String", # Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
"odbNetwork": "A String", # Optional. The name of the OdbNetwork associated with the DbSystem. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.
"odbSubnet": "A String", # Required. The name of the OdbSubnet associated with the DbSystem for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
"properties": { # The properties of a DbSystem. # Optional. The properties of the DbSystem.
"computeCount": 42, # Required. The number of CPU cores to enable for the DbSystem.
"computeModel": "A String", # Optional. The compute model of the DbSystem.
"dataCollectionOptions": { # Data collection options for DbSystem. # Optional. Data collection options for diagnostics.
"isDiagnosticsEventsEnabled": True or False, # Optional. Indicates whether to enable data collection for diagnostics.
"isIncidentLogsEnabled": True or False, # Optional. Indicates whether to enable incident logs and trace collection.
},
"dataStorageSizeGb": 42, # Optional. The data storage size in GB that is currently available to DbSystems.
"databaseEdition": "A String", # Required. The database edition of the DbSystem.
"dbHome": { # Details of the Database Home resource. # Optional. Details for creating a Database Home.
"database": { # Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/ # Required. The Database resource.
"adminPassword": "A String", # Required. The password for the default ADMIN user.
"characterSet": "A String", # Optional. The character set for the database. The default is AL32UTF8.
"createTime": "A String", # Output only. The date and time that the Database was created.
"databaseId": "A String", # Optional. The database ID of the Database.
"dbHomeName": "A String", # Optional. The name of the DbHome resource associated with the Database.
"dbName": "A String", # Optional. The database name. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
"dbUniqueName": "A String", # Optional. The DB_UNIQUE_NAME of the Oracle Database being backed up.
"gcpOracleZone": "A String", # Output only. The GCP Oracle zone where the Database is created.
"name": "A String", # Identifier. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}
"ncharacterSet": "A String", # Optional. The national character set for the database. The default is AL16UTF16.
"ociUrl": "A String", # Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
"opsInsightsStatus": "A String", # Output only. The Status of Operations Insights for this Database.
"properties": { # The properties of a Database. # Optional. The properties of the Database.
"databaseManagementConfig": { # The configuration of the Database Management service. # Output only. The Database Management config.
"managementState": "A String", # Output only. The status of the Database Management service.
"managementType": "A String", # Output only. The Database Management type.
},
"dbBackupConfig": { # Backup Options for the Database. # Optional. Backup options for the Database.
"autoBackupEnabled": True or False, # Optional. If set to true, enables automatic backups on the database.
"autoFullBackupDay": "A String", # Optional. The day of the week on which the full backup should be performed on the database. If no value is provided, it will default to Sunday.
"autoFullBackupWindow": "A String", # Optional. The window in which the full backup should be performed on the database. If no value is provided, the default is anytime.
"autoIncrementalBackupWindow": "A String", # Optional. The window in which the incremental backup should be performed on the database. If no value is provided, the default is anytime except the auto full backup day.
"backupDeletionPolicy": "A String", # Optional. This defines when the backups will be deleted after Database termination.
"backupDestinationDetails": [ # Optional. Details of the database backup destinations.
{ # The details of the database backup destination.
"type": "A String", # Optional. The type of the database backup destination.
},
],
"retentionPeriodDays": 42, # Optional. The number of days an automatic backup is retained before being automatically deleted. This value determines the earliest point in time to which a database can be restored. Min: 1, Max: 60.
},
"dbVersion": "A String", # Required. The Oracle Database version.
"state": "A String", # Output only. State of the Database.
},
"tdeWalletPassword": "A String", # Optional. The TDE wallet password for the database.
},
"dbVersion": "A String", # Required. A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.
"displayName": "A String", # Optional. The display name for the Database Home. The name does not have to be unique within your project.
"isUnifiedAuditingEnabled": True or False, # Optional. Whether unified auditing is enabled for the Database Home.
},
"dbSystemOptions": { # Details of the DbSystem Options. # Optional. The options for the DbSystem.
"storageManagement": "A String", # Optional. The storage option used in DB system.
},
"domain": "A String", # Optional. The host domain name of the DbSystem.
"hostname": "A String", # Output only. The hostname of the DbSystem.
"hostnamePrefix": "A String", # Optional. Prefix for DB System host names.
"initialDataStorageSizeGb": 42, # Required. The initial data storage size in GB.
"licenseModel": "A String", # Required. The license model of the DbSystem.
"lifecycleState": "A String", # Output only. State of the DbSystem.
"memorySizeGb": 42, # Optional. The memory size in GB.
"nodeCount": 42, # Optional. The number of nodes in the DbSystem.
"ocid": "A String", # Output only. OCID of the DbSystem.
"privateIp": "A String", # Optional. The private IP address of the DbSystem.
"recoStorageSizeGb": 42, # Optional. The reco/redo storage size in GB.
"shape": "A String", # Required. Shape of DB System.
"sshPublicKeys": [ # Required. SSH public keys to be stored with the DbSystem.
"A String",
],
"timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Optional. Time zone of the DbSystem.
"id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
"version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
},
}</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>Lists all the DbSystems for the given project and location.
Args:
parent: string, Required. The parent value for DbSystems in the following format: projects/{project}/locations/{location}. (required)
filter: string, Optional. An expression for filtering the results of the request.
orderBy: string, Optional. An expression for ordering the results of the request.
pageSize: integer, Optional. The maximum number of items to return. If unspecified, at most 50 DbSystems will be returned. The maximum value is 1000; values above 1000 will be coerced to 1000.
pageToken: string, Optional. A token identifying a page of results the server should return.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
2 - v2 error format
Returns:
An object of the form:
{ # The response for `DbSystem.List`.
"dbSystems": [ # The list of DbSystems.
{ # Details of the DbSystem (BaseDB) resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/DbSystem/
"createTime": "A String", # Output only. The date and time that the DbSystem was created.
"displayName": "A String", # Required. The display name for the System db. The name does not have to be unique within your project.
"entitlementId": "A String", # Output only. The ID of the subscription entitlement associated with the DbSystem
"gcpOracleZone": "A String", # Optional. The GCP Oracle zone where Oracle DbSystem is hosted. Example: us-east4-b-r2. If not specified, the system will pick a zone based on availability.
"labels": { # Optional. The labels or tags associated with the DbSystem.
"a_key": "A String",
},
"name": "A String", # Identifier. The name of the DbSystem resource in the following format: projects/{project}/locations/{region}/dbSystems/{db_system}
"ociUrl": "A String", # Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
"odbNetwork": "A String", # Optional. The name of the OdbNetwork associated with the DbSystem. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network} It is optional but if specified, this should match the parent ODBNetwork of the OdbSubnet.
"odbSubnet": "A String", # Required. The name of the OdbSubnet associated with the DbSystem for IP allocation. Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
"properties": { # The properties of a DbSystem. # Optional. The properties of the DbSystem.
"computeCount": 42, # Required. The number of CPU cores to enable for the DbSystem.
"computeModel": "A String", # Optional. The compute model of the DbSystem.
"dataCollectionOptions": { # Data collection options for DbSystem. # Optional. Data collection options for diagnostics.
"isDiagnosticsEventsEnabled": True or False, # Optional. Indicates whether to enable data collection for diagnostics.
"isIncidentLogsEnabled": True or False, # Optional. Indicates whether to enable incident logs and trace collection.
},
"dataStorageSizeGb": 42, # Optional. The data storage size in GB that is currently available to DbSystems.
"databaseEdition": "A String", # Required. The database edition of the DbSystem.
"dbHome": { # Details of the Database Home resource. # Optional. Details for creating a Database Home.
"database": { # Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/ # Required. The Database resource.
"adminPassword": "A String", # Required. The password for the default ADMIN user.
"characterSet": "A String", # Optional. The character set for the database. The default is AL32UTF8.
"createTime": "A String", # Output only. The date and time that the Database was created.
"databaseId": "A String", # Optional. The database ID of the Database.
"dbHomeName": "A String", # Optional. The name of the DbHome resource associated with the Database.
"dbName": "A String", # Optional. The database name. The name must begin with an alphabetic character and can contain a maximum of eight alphanumeric characters. Special characters are not permitted.
"dbUniqueName": "A String", # Optional. The DB_UNIQUE_NAME of the Oracle Database being backed up.
"gcpOracleZone": "A String", # Output only. The GCP Oracle zone where the Database is created.
"name": "A String", # Identifier. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database}
"ncharacterSet": "A String", # Optional. The national character set for the database. The default is AL16UTF16.
"ociUrl": "A String", # Output only. HTTPS link to OCI resources exposed to Customer via UI Interface.
"opsInsightsStatus": "A String", # Output only. The Status of Operations Insights for this Database.
"properties": { # The properties of a Database. # Optional. The properties of the Database.
"databaseManagementConfig": { # The configuration of the Database Management service. # Output only. The Database Management config.
"managementState": "A String", # Output only. The status of the Database Management service.
"managementType": "A String", # Output only. The Database Management type.
},
"dbBackupConfig": { # Backup Options for the Database. # Optional. Backup options for the Database.
"autoBackupEnabled": True or False, # Optional. If set to true, enables automatic backups on the database.
"autoFullBackupDay": "A String", # Optional. The day of the week on which the full backup should be performed on the database. If no value is provided, it will default to Sunday.
"autoFullBackupWindow": "A String", # Optional. The window in which the full backup should be performed on the database. If no value is provided, the default is anytime.
"autoIncrementalBackupWindow": "A String", # Optional. The window in which the incremental backup should be performed on the database. If no value is provided, the default is anytime except the auto full backup day.
"backupDeletionPolicy": "A String", # Optional. This defines when the backups will be deleted after Database termination.
"backupDestinationDetails": [ # Optional. Details of the database backup destinations.
{ # The details of the database backup destination.
"type": "A String", # Optional. The type of the database backup destination.
},
],
"retentionPeriodDays": 42, # Optional. The number of days an automatic backup is retained before being automatically deleted. This value determines the earliest point in time to which a database can be restored. Min: 1, Max: 60.
},
"dbVersion": "A String", # Required. The Oracle Database version.
"state": "A String", # Output only. State of the Database.
},
"tdeWalletPassword": "A String", # Optional. The TDE wallet password for the database.
},
"dbVersion": "A String", # Required. A valid Oracle Database version. For a list of supported versions, use the ListDbVersions operation.
"displayName": "A String", # Optional. The display name for the Database Home. The name does not have to be unique within your project.
"isUnifiedAuditingEnabled": True or False, # Optional. Whether unified auditing is enabled for the Database Home.
},
"dbSystemOptions": { # Details of the DbSystem Options. # Optional. The options for the DbSystem.
"storageManagement": "A String", # Optional. The storage option used in DB system.
},
"domain": "A String", # Optional. The host domain name of the DbSystem.
"hostname": "A String", # Output only. The hostname of the DbSystem.
"hostnamePrefix": "A String", # Optional. Prefix for DB System host names.
"initialDataStorageSizeGb": 42, # Required. The initial data storage size in GB.
"licenseModel": "A String", # Required. The license model of the DbSystem.
"lifecycleState": "A String", # Output only. State of the DbSystem.
"memorySizeGb": 42, # Optional. The memory size in GB.
"nodeCount": 42, # Optional. The number of nodes in the DbSystem.
"ocid": "A String", # Output only. OCID of the DbSystem.
"privateIp": "A String", # Optional. The private IP address of the DbSystem.
"recoStorageSizeGb": 42, # Optional. The reco/redo storage size in GB.
"shape": "A String", # Required. Shape of DB System.
"sshPublicKeys": [ # Required. SSH public keys to be stored with the DbSystem.
"A String",
],
"timeZone": { # Represents a time zone from the [IANA Time Zone Database](https://www.iana.org/time-zones). # Optional. Time zone of the DbSystem.
"id": "A String", # IANA Time Zone Database time zone. For example "America/New_York".
"version": "A String", # Optional. IANA Time Zone Database version number. For example "2019a".
},
},
},
],
"nextPageToken": "A String", # A token identifying a page of results the server should return.
}</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>
</body></html>
|
