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
|
<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.databases.html">databases</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="#get">get(name, x__xgafv=None)</a></code></p>
<p class="firstline">Gets details of a single Database.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">Lists all the Databases for the given project, location and DbSystem.</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="get">get(name, x__xgafv=None)</code>
<pre>Gets details of a single Database.
Args:
name: string, Required. The name of the Database resource in the following format: projects/{project}/locations/{region}/databases/{database} (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 Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/
"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.
}</pre>
</div>
<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>Lists all the Databases for the given project, location and DbSystem.
Args:
parent: string, Required. The parent resource name in the following format: projects/{project}/locations/{region} (required)
filter: string, Optional. An expression for filtering the results of the request. list for container databases is supported only with a valid dbSystem (full resource name) filter in this format: `dbSystem="projects/{project}/locations/{location}/dbSystems/{dbSystemId}"`
pageSize: integer, Optional. The maximum number of items to return. If unspecified, a maximum of 50 System Versions will be returned. The maximum value is 1000; values above 1000 will be reset to 1000.
pageToken: string, Optional. A token identifying the requested page of results to return. All fields except the filter should remain the same as in the request that provided this page token.
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 `Database.List`.
"databases": [ # The list of Databases.
{ # Details of the Database resource. https://docs.oracle.com/en-us/iaas/api/#/en/database/20160918/Database/
"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.
},
],
"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>
|
