Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 98b51f044ede8b9b24e584ab9680e3f35f4bd469 / . / docs / dyn / sqladmin_v1beta3.operations.html
blob: b73ae9dda35b1ee854d28e1aff627cbcb31c6160 [file] [log] [blame]
John Asmuth614db982014-04-24 15:46:26 -0400[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_v1beta3.html">Cloud SQL Administration API</a> . <a href="sqladmin_v1beta3.operations.html">operations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(project, instance, operation)</a></code></p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]79<p class="firstline">Retrieves information about a specific operation that was performed on a Cloud SQL instance.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]80<p class="toc_element">
81 <code><a href="#list">list(project, instance, maxResults=None, pageToken=None)</a></code></p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]82<p class="firstline">Lists all operations that have been performed on a Cloud SQL instance.</p>
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]83<p class="toc_element">
84 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88 <code class="details" id="get">get(project, instance, operation)</code>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]89 <pre>Retrieves information about a specific operation that was performed on a Cloud SQL instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]90
91Args:
92 project: string, Project ID of the project that contains the instance. (required)
93 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
94 operation: string, Instance operation ID. (required)
95
96Returns:
97 An object of the form:
98
99 { # 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.
100 "importContext": { # Database instance import context. # The context for import operation, if applicable.
101 "kind": "sql#importContext", # This is always sql#importContext.
102 "uri": [ # A path to the MySQL dump 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 also supported.
103 "A String",
104 ],
105 "database": "A String", # The database (for example, guestbook) to which the import is made. If not set, it is assumed that the database is specified in the file to be imported.
106 },
107 "kind": "sql#instanceOperation", # This is always sql#instanceOperation.
108 "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
109 "exportContext": { # Database instance export context. # The context for export operation, if applicable.
110 "table": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
111 "A String",
112 ],
113 "kind": "sql#exportContext", # This is always sql#exportContext.
114 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored, or where it was already stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If the filename ends with .gz, the contents are compressed.
115 "database": [ # Databases (for example, guestbook) from which the export is made. If unspecified, all databases are exported.
116 "A String",
117 ],
118 },
119 "instance": "A String", # Name of the database instance.
120 "state": "A String", # The state of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
121 "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
122 "error": [ # The error(s) encountered by this operation. Only set if the operation results in an error.
123 { # Database instance operation error.
124 "kind": "sql#operationError", # This is always sql#operationError.
125 "code": "A String", # Identifies the specific error that occurred.
126 },
127 ],
128 "operation": "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.
129 "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
130 "enqueuedTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
131 "userEmailAddress": "A String", # The email address of the user who initiated this operation.
132 }</pre>
133</div>
134
135<div class="method">
136 <code class="details" id="list">list(project, instance, maxResults=None, pageToken=None)</code>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]137 <pre>Lists all operations that have been performed on a Cloud SQL instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]138
139Args:
140 project: string, Project ID of the project that contains the instance. (required)
141 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
142 maxResults: integer, Maximum number of operations per response.
143 pageToken: string, A previously-returned page token representing part of the larger set of results to view.
144
145Returns:
146 An object of the form:
147
148 { # Database instance list operations response.
149 "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.
150 "items": [ # List of operation resources.
151 { # 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.
152 "importContext": { # Database instance import context. # The context for import operation, if applicable.
153 "kind": "sql#importContext", # This is always sql#importContext.
154 "uri": [ # A path to the MySQL dump 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 also supported.
155 "A String",
156 ],
157 "database": "A String", # The database (for example, guestbook) to which the import is made. If not set, it is assumed that the database is specified in the file to be imported.
158 },
159 "kind": "sql#instanceOperation", # This is always sql#instanceOperation.
160 "startTime": "A String", # The time this operation actually started in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
161 "exportContext": { # Database instance export context. # The context for export operation, if applicable.
162 "table": [ # Tables to export, or that were exported, from the specified database. If you specify tables, specify one and only one database.
163 "A String",
164 ],
165 "kind": "sql#exportContext", # This is always sql#exportContext.
166 "uri": "A String", # The path to the file in Google Cloud Storage where the export will be stored, or where it was already stored. The URI is in the form gs://bucketName/fileName. If the file already exists, the operation fails. If the filename ends with .gz, the contents are compressed.
167 "database": [ # Databases (for example, guestbook) from which the export is made. If unspecified, all databases are exported.
168 "A String",
169 ],
170 },
171 "instance": "A String", # Name of the database instance.
172 "state": "A String", # The state of an operation. Valid values are PENDING, RUNNING, DONE, UNKNOWN.
173 "operationType": "A String", # The type of the operation. Valid values are CREATE, DELETE, UPDATE, RESTART, IMPORT, EXPORT, BACKUP_VOLUME, RESTORE_VOLUME.
174 "error": [ # The error(s) encountered by this operation. Only set if the operation results in an error.
175 { # Database instance operation error.
176 "kind": "sql#operationError", # This is always sql#operationError.
177 "code": "A String", # Identifies the specific error that occurred.
178 },
179 ],
180 "operation": "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.
181 "endTime": "A String", # The time this operation finished in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
182 "enqueuedTime": "A String", # The time this operation was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
183 "userEmailAddress": "A String", # The email address of the user who initiated this operation.
184 },
185 ],
186 "kind": "sql#operationsList", # This is always sql#operationsList.
187 }</pre>
188</div>
189
190<div class="method">
191 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
192 <pre>Retrieves the next page of results.
193
194Args:
195 previous_request: The request for the previous page. (required)
196 previous_response: The response from the request for the previous page. (required)
197
198Returns:
199 A request object that you can call 'execute()' on to request the next
200 page. Returns None if there are no more items in the collection.
201 </pre>
202</div>
203
204</body></html>