Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / google-api-python-client / e633be11dbb412e5030b5afca31111fa4074dff1 / . / docs / dyn / sqladmin_v1beta4.backupRuns.html
blob: 38b6784741ae688fe49cc85e606c8fac67e1108a [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">
78 <code><a href="#get">get(project, instance, id)</a></code></p>
79<p class="firstline">Retrieves a resource containing information about a backup run.</p>
80<p class="toc_element">
81 <code><a href="#list">list(project, instance, maxResults=None, pageToken=None)</a></code></p>
82<p class="firstline">Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the enqueued time.</p>
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, id)</code>
89 <pre>Retrieves a resource containing information about a backup run.
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 id: string, The ID of this Backup Run. (required)
95
96Returns:
97 An object of the form:
98
99 { # A database instance backup run resource.
100 "status": "A String", # The status of this run.
101 "kind": "sql#backupRun", # This is always sql#backupRun.
102 "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.
103 "enqueuedTime": "A String", # The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
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 "message": "A String", # Additional information about the error encountered.
110 },
111 "endTime": "A String", # The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
112 "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.
113 "selfLink": "A String", # The URI of this resource.
114 }</pre>
115</div>
116
117<div class="method">
118 <code class="details" id="list">list(project, instance, maxResults=None, pageToken=None)</code>
119 <pre>Lists all backup runs associated with a given instance and configuration in the reverse chronological order of the enqueued time.
120
121Args:
122 project: string, Project ID of the project that contains the instance. (required)
123 instance: string, Cloud SQL instance ID. This does not include the project ID. (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 "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.
137 "enqueuedTime": "A String", # The time the run was enqueued in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
138 "instance": "A String", # Name of the database instance.
139 "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.
140 "error": { # Database instance operation error. # Information about why the backup operation failed. This is only present if the run has the FAILED status.
141 "kind": "sql#operationError", # This is always sql#operationError.
142 "code": "A String", # Identifies the specific error that occurred.
143 "message": "A String", # Additional information about the error encountered.
144 },
145 "endTime": "A String", # The time the backup operation completed in UTC timezone in RFC 3339 format, for example 2012-11-15T16:19:00.094Z.
146 "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.
147 "selfLink": "A String", # The URI of this resource.
148 },
149 ],
150 "kind": "sql#backupRunsList", # This is always sql#backupRunsList.
151 }</pre>
152</div>
153
154<div class="method">
155 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
156 <pre>Retrieves the next page of results.
157
158Args:
159 previous_request: The request for the previous page. (required)
160 previous_response: The response from the request for the previous page. (required)
161
162Returns:
163 A request object that you can call 'execute()' on to request the next
164 page. Returns None if there are no more items in the collection.
165 </pre>
166</div>
167
168</body></html>