blob: bf5d8bc97fefa92fd25e6a1f2a718eec60053ec7 [file] [log] [blame]
Bu Sun Kim65020912020-05-20 12:08:20 -07001<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="spanner_v1.html">Cloud Spanner API</a> . <a href="spanner_v1.projects.html">projects</a> . <a href="spanner_v1.projects.instances.html">instances</a> . <a href="spanner_v1.projects.instances.backupOperations.html">backupOperations</a></h1>
76<h2>Instance Methods</h2>
77<p class="toc_element">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070078 <code><a href="#list">list(parent, pageSize=None, pageToken=None, filter=None, x__xgafv=None)</a></code></p>
Bu Sun Kim65020912020-05-20 12:08:20 -070079<p class="firstline">Lists the backup long-running operations in</p>
80<p class="toc_element">
81 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
82<p class="firstline">Retrieves the next page of results.</p>
83<h3>Method Details</h3>
84<div class="method">
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -070085 <code class="details" id="list">list(parent, pageSize=None, pageToken=None, filter=None, x__xgafv=None)</code>
Bu Sun Kim65020912020-05-20 12:08:20 -070086 <pre>Lists the backup long-running operations in
87the given instance. A backup operation has a name of the form
88`projects/&lt;project&gt;/instances/&lt;instance&gt;/backups/&lt;backup&gt;/operations/&lt;operation&gt;`.
89The long-running operation
90metadata field type
91`metadata.type_url` describes the type of the metadata. Operations returned
92include those that have completed/failed/canceled within the last 7 days,
93and pending operations. Operations returned are ordered by
94`operation.metadata.value.progress.start_time` in descending order starting
95from the most recently started operation.
96
97Args:
98 parent: string, Required. The instance of the backup operations. Values are of
99the form `projects/&lt;project&gt;/instances/&lt;instance&gt;`. (required)
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700100 pageSize: integer, Number of operations to be returned in the response. If 0 or
101less, defaults to the server&#x27;s maximum allowed page size.
102 pageToken: string, If non-empty, `page_token` should contain a
103next_page_token
104from a previous ListBackupOperationsResponse to the
105same `parent` and with the same `filter`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700106 filter: string, An expression that filters the list of returned backup operations.
107
108A filter expression consists of a field name, a
109comparison operator, and a value for filtering.
110The value must be a string, a number, or a boolean. The comparison operator
111must be one of: `&lt;`, `&gt;`, `&lt;=`, `&gt;=`, `!=`, `=`, or `:`.
112Colon `:` is the contains operator. Filter rules are not case sensitive.
113
114The following fields in the operation
115are eligible for filtering:
116
117 * `name` - The name of the long-running operation
118 * `done` - False if the operation is in progress, else true.
119 * `metadata.@type` - the type of metadata. For example, the type string
120 for CreateBackupMetadata is
121 `type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata`.
122 * `metadata.&lt;field_name&gt;` - any field in metadata.value.
123 * `error` - Error associated with the long-running operation.
124 * `response.@type` - the type of response.
125 * `response.&lt;field_name&gt;` - any field in response.value.
126
127You can combine multiple expressions by enclosing each expression in
128parentheses. By default, expressions are combined with AND logic, but
129you can specify AND, OR, and NOT logic explicitly.
130
131Here are a few examples:
132
133 * `done:true` - The operation is complete.
134 * `metadata.database:prod` - The database the backup was taken from has
135 a name containing the string &quot;prod&quot;.
136 * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.CreateBackupMetadata) AND` &lt;br/&gt;
137 `(metadata.name:howl) AND` &lt;br/&gt;
138 `(metadata.progress.start_time &lt; \&quot;2018-03-28T14:50:00Z\&quot;) AND` &lt;br/&gt;
139 `(error:*)` - Returns operations where:
140 * The operation&#x27;s metadata type is CreateBackupMetadata.
141 * The backup name contains the string &quot;howl&quot;.
142 * The operation started before 2018-03-28T14:50:00Z.
143 * The operation resulted in an error.
Bu Sun Kim65020912020-05-20 12:08:20 -0700144 x__xgafv: string, V1 error format.
145 Allowed values
146 1 - v1 error format
147 2 - v2 error format
148
149Returns:
150 An object of the form:
151
152 { # The response for
153 # ListBackupOperations.
Bu Sun Kim65020912020-05-20 12:08:20 -0700154 &quot;operations&quot;: [ # The list of matching backup long-running
155 # operations. Each operation&#x27;s name will be
156 # prefixed by the backup&#x27;s name and the operation&#x27;s
157 # metadata will be of type
158 # CreateBackupMetadata. Operations returned include those that are
159 # pending or have completed/failed/canceled within the last 7 days.
160 # Operations returned are ordered by
161 # `operation.metadata.value.progress.start_time` in descending order starting
162 # from the most recently started operation.
163 { # This resource represents a long-running operation that is the result of a
164 # network API call.
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700165 &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
166 # different programming environments, including REST APIs and RPC APIs. It is
167 # used by [gRPC](https://github.com/grpc). Each `Status` message contains
168 # three pieces of data: error code, error message, and error details.
169 #
170 # You can find out more about this error model and how to work with it in the
171 # [API Design Guide](https://cloud.google.com/apis/design/errors).
172 &quot;details&quot;: [ # A list of messages that carry the error details. There is a common set of
173 # message types for APIs to use.
174 {
175 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
176 },
177 ],
178 &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
179 # user-facing error message should be localized and sent in the
180 # google.rpc.Status.details field, or localized by the client.
181 &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
182 },
183 &quot;metadata&quot;: { # Service-specific metadata associated with the operation. It typically
184 # contains progress information and common metadata such as create time.
185 # Some services might not provide such metadata. Any method that returns a
186 # long-running operation should document the metadata type, if any.
187 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
188 },
189 &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
190 # originally returns it. If you use the default HTTP mapping, the
191 # `name` should be a resource name ending with `operations/{unique_id}`.
Bu Sun Kim65020912020-05-20 12:08:20 -0700192 &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
193 # If `true`, the operation is completed, and either `error` or `response` is
194 # available.
195 &quot;response&quot;: { # The normal response of the operation in case of success. If the original
196 # method returns no data on success, such as `Delete`, the response is
197 # `google.protobuf.Empty`. If the original method is standard
198 # `Get`/`Create`/`Update`, the response should be the resource. For other
199 # methods, the response should have the type `XxxResponse`, where `Xxx`
200 # is the original method name. For example, if the original method name
201 # is `TakeSnapshot()`, the inferred response type is
202 # `TakeSnapshotResponse`.
203 &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
204 },
Bu Sun Kim65020912020-05-20 12:08:20 -0700205 },
206 ],
Bu Sun Kim4ed7d3f2020-05-27 12:20:54 -0700207 &quot;nextPageToken&quot;: &quot;A String&quot;, # `next_page_token` can be sent in a subsequent
208 # ListBackupOperations
209 # call to fetch more of the matching metadata.
Bu Sun Kim65020912020-05-20 12:08:20 -0700210 }</pre>
211</div>
212
213<div class="method">
214 <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
215 <pre>Retrieves the next page of results.
216
217Args:
218 previous_request: The request for the previous page. (required)
219 previous_response: The response from the request for the previous page. (required)
220
221Returns:
222 A request object that you can call &#x27;execute()&#x27; on to request the next
223 page. Returns None if there are no more items in the collection.
224 </pre>
225</div>
226
227</body></html>