| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 1 | <html><body> |
| 2 | <style> |
| 3 | |
| 4 | body, 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 | |
| 15 | body { |
| 16 | font-size: 13px; |
| 17 | padding: 1em; |
| 18 | } |
| 19 | |
| 20 | h1 { |
| 21 | font-size: 26px; |
| 22 | margin-bottom: 1em; |
| 23 | } |
| 24 | |
| 25 | h2 { |
| 26 | font-size: 24px; |
| 27 | margin-bottom: 1em; |
| 28 | } |
| 29 | |
| 30 | h3 { |
| 31 | font-size: 20px; |
| 32 | margin-bottom: 1em; |
| 33 | margin-top: 1em; |
| 34 | } |
| 35 | |
| 36 | pre, code { |
| 37 | line-height: 1.5; |
| 38 | font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; |
| 39 | } |
| 40 | |
| 41 | pre { |
| 42 | margin-top: 0.5em; |
| 43 | } |
| 44 | |
| 45 | h1, h2, h3, p { |
| 46 | font-family: Arial, sans serif; |
| 47 | } |
| 48 | |
| 49 | h1, 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.databaseOperations.html">databaseOperations</a></h1> |
| 76 | <h2>Instance Methods</h2> |
| 77 | <p class="toc_element"> |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 78 | <code><a href="#list">list(parent, pageSize=None, pageToken=None, filter=None, x__xgafv=None)</a></code></p> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 79 | <p class="firstline">Lists database longrunning-operations.</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 Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 85 | <code class="details" id="list">list(parent, pageSize=None, pageToken=None, filter=None, x__xgafv=None)</code> |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 86 | <pre>Lists database longrunning-operations. |
| 87 | A database operation has a name of the form |
| 88 | `projects/<project>/instances/<instance>/databases/<database>/operations/<operation>`. |
| 89 | The long-running operation |
| 90 | metadata field type |
| 91 | `metadata.type_url` describes the type of the metadata. Operations returned |
| 92 | include those that have completed/failed/canceled within the last 7 days, |
| 93 | and pending operations. |
| 94 | |
| 95 | Args: |
| 96 | parent: string, Required. The instance of the database operations. |
| 97 | Values are of the form `projects/<project>/instances/<instance>`. (required) |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 98 | pageSize: integer, Number of operations to be returned in the response. If 0 or |
| 99 | less, defaults to the server's maximum allowed page size. |
| 100 | pageToken: string, If non-empty, `page_token` should contain a |
| 101 | next_page_token |
| 102 | from a previous ListDatabaseOperationsResponse to the |
| 103 | same `parent` and with the same `filter`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 104 | filter: string, An expression that filters the list of returned operations. |
| 105 | |
| 106 | A filter expression consists of a field name, a |
| 107 | comparison operator, and a value for filtering. |
| 108 | The value must be a string, a number, or a boolean. The comparison operator |
| 109 | must be one of: `<`, `>`, `<=`, `>=`, `!=`, `=`, or `:`. |
| 110 | Colon `:` is the contains operator. Filter rules are not case sensitive. |
| 111 | |
| 112 | The following fields in the Operation |
| 113 | are eligible for filtering: |
| 114 | |
| 115 | * `name` - The name of the long-running operation |
| 116 | * `done` - False if the operation is in progress, else true. |
| 117 | * `metadata.@type` - the type of metadata. For example, the type string |
| 118 | for RestoreDatabaseMetadata is |
| 119 | `type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata`. |
| 120 | * `metadata.<field_name>` - any field in metadata.value. |
| 121 | * `error` - Error associated with the long-running operation. |
| 122 | * `response.@type` - the type of response. |
| 123 | * `response.<field_name>` - any field in response.value. |
| 124 | |
| 125 | You can combine multiple expressions by enclosing each expression in |
| 126 | parentheses. By default, expressions are combined with AND logic. However, |
| 127 | you can specify AND, OR, and NOT logic explicitly. |
| 128 | |
| 129 | Here are a few examples: |
| 130 | |
| 131 | * `done:true` - The operation is complete. |
| 132 | * `(metadata.@type=type.googleapis.com/google.spanner.admin.database.v1.RestoreDatabaseMetadata) AND` <br/> |
| 133 | `(metadata.source_type:BACKUP) AND` <br/> |
| 134 | `(metadata.backup_info.backup:backup_howl) AND` <br/> |
| 135 | `(metadata.name:restored_howl) AND` <br/> |
| 136 | `(metadata.progress.start_time < \"2018-03-28T14:50:00Z\") AND` <br/> |
| 137 | `(error:*)` - Return operations where: |
| 138 | * The operation's metadata type is RestoreDatabaseMetadata. |
| 139 | * The database is restored from a backup. |
| 140 | * The backup name contains "backup_howl". |
| 141 | * The restored database's name contains "restored_howl". |
| 142 | * The operation started before 2018-03-28T14:50:00Z. |
| 143 | * The operation resulted in an error. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 144 | x__xgafv: string, V1 error format. |
| 145 | Allowed values |
| 146 | 1 - v1 error format |
| 147 | 2 - v2 error format |
| 148 | |
| 149 | Returns: |
| 150 | An object of the form: |
| 151 | |
| 152 | { # The response for |
| 153 | # ListDatabaseOperations. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 154 | "operations": [ # The list of matching database long-running |
| 155 | # operations. Each operation's name will be |
| 156 | # prefixed by the database's name. The operation's |
| 157 | # metadata field type |
| 158 | # `metadata.type_url` describes the type of the metadata. |
| 159 | { # This resource represents a long-running operation that is the result of a |
| 160 | # network API call. |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 161 | "error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation. |
| 162 | # different programming environments, including REST APIs and RPC APIs. It is |
| 163 | # used by [gRPC](https://github.com/grpc). Each `Status` message contains |
| 164 | # three pieces of data: error code, error message, and error details. |
| 165 | # |
| 166 | # You can find out more about this error model and how to work with it in the |
| 167 | # [API Design Guide](https://cloud.google.com/apis/design/errors). |
| 168 | "details": [ # A list of messages that carry the error details. There is a common set of |
| 169 | # message types for APIs to use. |
| 170 | { |
| 171 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 172 | }, |
| 173 | ], |
| 174 | "message": "A String", # A developer-facing error message, which should be in English. Any |
| 175 | # user-facing error message should be localized and sent in the |
| 176 | # google.rpc.Status.details field, or localized by the client. |
| 177 | "code": 42, # The status code, which should be an enum value of google.rpc.Code. |
| 178 | }, |
| 179 | "metadata": { # Service-specific metadata associated with the operation. It typically |
| 180 | # contains progress information and common metadata such as create time. |
| 181 | # Some services might not provide such metadata. Any method that returns a |
| 182 | # long-running operation should document the metadata type, if any. |
| 183 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 184 | }, |
| 185 | "name": "A String", # The server-assigned name, which is only unique within the same service that |
| 186 | # originally returns it. If you use the default HTTP mapping, the |
| 187 | # `name` should be a resource name ending with `operations/{unique_id}`. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 188 | "done": True or False, # If the value is `false`, it means the operation is still in progress. |
| 189 | # If `true`, the operation is completed, and either `error` or `response` is |
| 190 | # available. |
| 191 | "response": { # The normal response of the operation in case of success. If the original |
| 192 | # method returns no data on success, such as `Delete`, the response is |
| 193 | # `google.protobuf.Empty`. If the original method is standard |
| 194 | # `Get`/`Create`/`Update`, the response should be the resource. For other |
| 195 | # methods, the response should have the type `XxxResponse`, where `Xxx` |
| 196 | # is the original method name. For example, if the original method name |
| 197 | # is `TakeSnapshot()`, the inferred response type is |
| 198 | # `TakeSnapshotResponse`. |
| 199 | "a_key": "", # Properties of the object. Contains field @type with type URL. |
| 200 | }, |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 201 | }, |
| 202 | ], |
| Bu Sun Kim | 4ed7d3f | 2020-05-27 12:20:54 -0700 | [diff] [blame^] | 203 | "nextPageToken": "A String", # `next_page_token` can be sent in a subsequent |
| 204 | # ListDatabaseOperations |
| 205 | # call to fetch more of the matching metadata. |
| Bu Sun Kim | 6502091 | 2020-05-20 12:08:20 -0700 | [diff] [blame] | 206 | }</pre> |
| 207 | </div> |
| 208 | |
| 209 | <div class="method"> |
| 210 | <code class="details" id="list_next">list_next(previous_request, previous_response)</code> |
| 211 | <pre>Retrieves the next page of results. |
| 212 | |
| 213 | Args: |
| 214 | previous_request: The request for the previous page. (required) |
| 215 | previous_response: The response from the request for the previous page. (required) |
| 216 | |
| 217 | Returns: |
| 218 | A request object that you can call 'execute()' on to request the next |
| 219 | page. Returns None if there are no more items in the collection. |
| 220 | </pre> |
| 221 | </div> |
| 222 | |
| 223 | </body></html> |