Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / 98b51f044ede8b9b24e584ab9680e3f35f4bd469 / . / docs / dyn / sqladmin_v1beta3.backupRuns.html
blob: 995235ea133de2624adb339c9d76c706a18b6070 [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.backupRuns.html">backupRuns</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
78 <code><a href="#get">get(project, instance, backupConfiguration, dueTime)</a></code></p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]79<p class="firstline">Retrieves information about a specified backup run for 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, backupConfiguration, maxResults=None, pageToken=None)</a></code></p>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]82<p class="firstline">Lists all backup runs associated with 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, backupConfiguration, dueTime)</code>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]89 <pre>Retrieves information about a specified backup run for 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 backupConfiguration: string, Identifier for the backup configuration. This gets generated automatically when a backup configuration is created. (required)
Sai Cheemalapatidf613972016-10-21 13:59:49 -0700[diff] [blame]95 dueTime: string, The start time of the four-hour backup window. The backup can occur any time in the window. The time is in RFC 3339 format, for example 2012-11-15T16:19:00.094Z. (required)
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]96
97Returns:
98 An object of the form:
99
100 { # A database instance backup run resource.
101 "status": "A String", # The status of this run.
102 "kind": "sql#backupRun", # This is always sql#backupRun.
103 "backupConfiguration": "A String", # Backup Configuration identifier.
104 "instance": "A String", # Name of the database instance.
105 "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.
106 "error": { # Database instance operation error. # Information about why the backup operation failed. This is only present if the run has the FAILED status.
107 "kind": "sql#operationError", # This is always sql#operationError.
108 "code": "A String", # Identifies the specific error that occurred.
109 },
110 "endTime": "A String", # The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
111 "enqueuedTime": "A String", # The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
112 "dueTime": "A String", # The due time of this run in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
113 }</pre>
114</div>
115
116<div class="method">
117 <code class="details" id="list">list(project, instance, backupConfiguration, maxResults=None, pageToken=None)</code>
Craig Citro0e5b9bf2014-10-15 10:26:14 -0700[diff] [blame]118 <pre>Lists all backup runs associated with a Cloud SQL instance.
John Asmuth614db982014-04-24 15:46:26 -0400[diff] [blame]119
120Args:
121 project: string, Project ID of the project that contains the instance. (required)
122 instance: string, Cloud SQL instance ID. This does not include the project ID. (required)
123 backupConfiguration: string, Identifier for the backup configuration. This gets generated automatically when a backup configuration is created. (required)
124 maxResults: integer, Maximum number of backup runs per response.
125 pageToken: string, A previously-returned page token representing part of the larger set of results to view.
126
127Returns:
128 An object of the form:
129
130 { # Backup run list results.
131 "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.
132 "items": [ # A list of backup runs in reverse chronological order of the enqueued time.
133 { # A database instance backup run resource.
134 "status": "A String", # The status of this run.
135 "kind": "sql#backupRun", # This is always sql#backupRun.
136 "backupConfiguration": "A String", # Backup Configuration identifier.
137 "instance": "A String", # Name of the database instance.
138 "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.
139 "error": { # Database instance operation error. # Information about why the backup operation failed. This is only present if the run has the FAILED status.
140 "kind": "sql#operationError", # This is always sql#operationError.
141 "code": "A String", # Identifies the specific error that occurred.
142 },
143 "endTime": "A String", # The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
144 "enqueuedTime": "A String", # The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
145 "dueTime": "A String", # The due time of this run in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
146 },
147 ],
148 "kind": "sql#backupRunsList", # This is always sql#backupRunsList.
149 }</pre>
150</div>
151
152<div class="method">
153 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
154 <pre>Retrieves the next page of results.
155
156Args:
157 previous_request: The request for the previous page. (required)
158 previous_response: The response from the request for the previous page. (required)
159
160Returns:
161 A request object that you can call 'execute()' on to request the next
162 page. Returns None if there are no more items in the collection.
163 </pre>
164</div>
165
166</body></html>