Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 36e41bc9e5f0c6e6d5920ae4a5c9802ca63554e2 / . / docs / dyn / sqladmin_v1beta4.backupRuns.html
blob: b9f5b58e840dea62b0471f9f5213efc07a4ee4e8 [file] [log] [blame]
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]1<html><body>
2<style>
3
4body, h1, h2, h3, div, span, p, pre, a {
5 margin: 0;
6 padding: 0;
7 border: 0;
8 font-weight: inherit;
9 font-style: inherit;
10 font-size: 100%;
11 font-family: inherit;
12 vertical-align: baseline;
13}
14
15body {
16 font-size: 13px;
17 padding: 1em;
18}
19
20h1 {
21 font-size: 26px;
22 margin-bottom: 1em;
23}
24
25h2 {
26 font-size: 24px;
27 margin-bottom: 1em;
28}
29
30h3 {
31 font-size: 20px;
32 margin-bottom: 1em;
33 margin-top: 1em;
34}
35
36pre, code {
37 line-height: 1.5;
38 font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
39}
40
41pre {
42 margin-top: 0.5em;
43}
44
45h1, h2, h3, p {
46 font-family: Arial, sans serif;
47}
48
49h1, h2, h3 {
50 border-bottom: solid #CCC 1px;
51}
52
53.toc_element {
54 margin-top: 0.5em;
55}
56
57.firstline {
58 margin-left: 2 em;
59}
60
61.method {
62 margin-top: 1em;
63 border: solid 1px #CCC;
64 padding: 1em;
65 background: #EEE;
66}
67
68.details {
69 font-weight: bold;
70 font-size: 14px;
71}
72
73</style>
74
75<h1><a href="sqladmin_v1beta4.html">Cloud SQL Administration API</a> . <a href="sqladmin_v1beta4.backupRuns.html">backupRuns</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]78 <code><a href="#delete">delete(project, instance, id)</a></code></p>
79<p class="firstline">Deletes the backup taken by a backup run.</p>
80<p class="toc_element">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]81 <code><a href="#get">get(project, instance, id)</a></code></p>
82<p class="firstline">Retrieves a resource containing information about a backup run.</p>
83<p class="toc_element">
84 <code><a href="#list">list(project, instance, maxResults=None, pageToken=None)</a></code></p>
85<p class="firstline">Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the enqueued time.</p>
86<p class="toc_element">
87 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
88<p class="firstline">Retrieves the next page of results.</p>
89<h3>Method Details</h3>
90<div class="method">
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]91 <code class="details" id="delete">delete(project, instance, id)</code>
92 <pre>Deletes the backup taken by a backup run.
93
94Args:
95 project: string, Project ID of the project that contains the instance. (required)
96 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]97 id: string, The ID of the Backup Run to delete. To find a Backup Run ID, use the list method. (required)
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]98
99Returns:
100 An object of the form:
101
102 { # An Operations resource contains information about database instance operations such as create, delete, and restart. Operations resources are created in response to operations that were initiated; you never create them directly.
103 "status": "A String", # The status of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
104 "importContext": { # Database instance import context. # The context for import operation, if applicable.
105 "fileType": "A String", # The file type for the specified uri.
106 # SQL: The file contains SQL statements.
107 # CSV: The file contains CSV data.
108 "database": "A String", # The database (for example, guestbook) to which the import is made. If fileType is SQL and no database is specified, it is assumed that the database is specified in the file to be imported. If fileType is CSV, it must be specified.
109 "kind": "sql#importContext", # This is always sql#importContext.
110 "uri": "A String", # A path to the file in Google Cloud Storage from which the import is made. The URI is in the form gs://bucketName/fileName. Compressed gzip files (.gz) are supported when fileType is SQL.
111 "csvImportOptions": { # Options for importing data as CSV.
112 "table": "A String", # The table to which CSV data is imported.
113 "columns": [ # The columns to which CSV data is imported. If not specified, all columns of the database table are loaded with CSV data.
114 "A String",
115 ],
116 },
117 },
118 "kind": "sql#operation", # This is always sql#operation.
119 "name": "A String", # An identifier that uniquely identifies the operation. You can use this identifier to retrieve the Operations resource that has information about the operation.
120 "exportContext": { # Database instance export context. # The context for export operation, if applicable.
121 "kind": "sql#exportContext", # This is always sql#exportContext.
122 "fileType": "A String", # The file type for the specified uri.
123 # SQL: The file contains SQL statements.
124 # CSV: The file contains CSV data.
125 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If fileType is SQL and the filename ends with .gz, the contents are compressed.
126 "csvExportOptions": { # Options for exporting data as CSV.
127 "selectQuery": "A String", # The select query used to extract the data.
128 },
129 "databases": [ # Databases (for example, guestbook) from which the export is made. If fileType is SQL and no database is specified, all databases are exported. If fileType is CSV, you can optionally specify at most one database to export. If csvExportOptions.selectQuery also specifies the database, this field will be ignored.
130 "A String",
131 ],
132 "sqlExportOptions": { # Options for exporting data as SQL statements.
133 "tables": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
134 "A String",
135 ],
Jon Wayne Parrott36e41bc2016-02-19 16:02:29 -0800[diff] [blame^]136 "schemaOnly": True or False, # Export only schemas.
Takashi Matsuo06694102015-09-11 13:55:40 -0700[diff] [blame]137 },
138 },
139 "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
140 "targetProject": "A String", # The project ID of the target instance related to this operation.
141 "targetId": "A String", # Name of the database instance related to this operation.
142 "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME, CREATE_USER, DELETE_USER, CREATE_DATABASE, DELETE_DATABASE .
143 "targetLink": "A String", # The URI of the instance related to the operation.
144 "insertTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
145 "error": { # Database instance operation errors list wrapper. # If errors occurred during processing of this operation, this field will be populated.
146 "kind": "sql#operationErrors", # This is always sql#operationErrors.
147 "errors": [ # The list of errors encountered while processing this operation.
148 { # Database instance operation error.
149 "kind": "sql#operationError", # This is always sql#operationError.
150 "code": "A String", # Identifies the specific error that occurred.
151 "message": "A String", # Additional information about the error encountered.
152 },
153 ],
154 },
155 "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
156 "selfLink": "A String", # The URI of this resource.
157 "user": "A String", # The email address of the user who initiated this operation.
158 }</pre>
159</div>
160
161<div class="method">
Craig Citroe633be12015-03-02 13:40:36 -0800[diff] [blame]162 <code class="details" id="get">get(project, instance, id)</code>
163 <pre>Retrieves a resource containing information about a backup run.
164
165Args:
166 project: string, Project ID of the project that contains the instance. (required)
167 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
168 id: string, The ID of this Backup Run. (required)
169
170Returns:
171 An object of the form:
172
173 { # A database instance backup run resource.
174 "status": "A String", # The status of this run.
175 "kind": "sql#backupRun", # This is always sql#backupRun.
176 "windowStartTime": "A String", # The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
177 "enqueuedTime": "A String", # The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
178 "instance": "A String", # Name of the database instance.
179 "startTime": "A String", # The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
180 "error": { # Database instance operation error. # Information about why the backup operation failed. This is only present if the run has the FAILED status.
181 "kind": "sql#operationError", # This is always sql#operationError.
182 "code": "A String", # Identifies the specific error that occurred.
183 "message": "A String", # Additional information about the error encountered.
184 },
185 "endTime": "A String", # The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
186 "id": "A String", # A unique identifier for this backup run. Note that this is unique only within the scope of a particular Cloud SQL instance.
187 "selfLink": "A String", # The URI of this resource.
188 }</pre>
189</div>
190
191<div class="method">
192 <code class="details" id="list">list(project, instance, maxResults=None, pageToken=None)</code>
193 <pre>Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the enqueued time.
194
195Args:
196 project: string, Project ID of the project that contains the instance. (required)
197 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
198 maxResults: integer, Maximum number of backup runs per response.
199 pageToken: string, A previously-returned page token representing part of the larger set of results to view.
200
201Returns:
202 An object of the form:
203
204 { # Backup run list results.
205 "nextPageToken": "A String", # The continuation token, used to page through large result sets. Provide this value in a subsequent request to return the next page of results.
206 "items": [ # A list of backup runs in reverse chronological order of the enqueued time.
207 { # A database instance backup run resource.
208 "status": "A String", # The status of this run.
209 "kind": "sql#backupRun", # This is always sql#backupRun.
210 "windowStartTime": "A String", # The start time of the backup window during which this the backup was attempted in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
211 "enqueuedTime": "A String", # The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
212 "instance": "A String", # Name of the database instance.
213 "startTime": "A String", # The time the backup operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
214 "error": { # Database instance operation error. # Information about why the backup operation failed. This is only present if the run has the FAILED status.
215 "kind": "sql#operationError", # This is always sql#operationError.
216 "code": "A String", # Identifies the specific error that occurred.
217 "message": "A String", # Additional information about the error encountered.
218 },
219 "endTime": "A String", # The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
220 "id": "A String", # A unique identifier for this backup run. Note that this is unique only within the scope of a particular Cloud SQL instance.
221 "selfLink": "A String", # The URI of this resource.
222 },
223 ],
224 "kind": "sql#backupRunsList", # This is always sql#backupRunsList.
225 }</pre>
226</div>
227
228<div class="method">
229 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
230 <pre>Retrieves the next page of results.
231
232Args:
233 previous_request: The request for the previous page. (required)
234 previous_response: The response from the request for the previous page. (required)
235
236Returns:
237 A request object that you can call 'execute()' on to request the next
238 page. Returns None if there are no more items in the collection.
239 </pre>
240</div>
241
242</body></html>