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="firestore_v1beta1.html">Cloud Firestore API</a> . <a href="firestore_v1beta1.projects.html">projects</a> . <a href="firestore_v1beta1.projects.databases.html">databases</a> . <a href="firestore_v1beta1.projects.databases.indexes.html">indexes</a></h1> 76<h2>Instance Methods</h2> 77<p class="toc_element"> 78 <code><a href="#create">create(parent, body, x__xgafv=None)</a></code></p> 79<p class="firstline">Creates the specified index.</p> 80<p class="toc_element"> 81 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 82<p class="firstline">Deletes an index.</p> 83<p class="toc_element"> 84 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Gets an index.</p> 86<p class="toc_element"> 87 <code><a href="#list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</a></code></p> 88<p class="firstline">Lists the indexes that match the specified filters.</p> 89<p class="toc_element"> 90 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 91<p class="firstline">Retrieves the next page of results.</p> 92<h3>Method Details</h3> 93<div class="method"> 94 <code class="details" id="create">create(parent, body, x__xgafv=None)</code> 95 <pre>Creates the specified index. 96A newly created index's initial state is `CREATING`. On completion of the 97returned google.longrunning.Operation, the state will be `READY`. 98If the index already exists, the call will return an `ALREADY_EXISTS` 99status. 100 101During creation, the process could result in an error, in which case the 102index will move to the `ERROR` state. The process can be recovered by 103fixing the data that caused the error, removing the index with 104delete, then re-creating the index with 105create. 106 107Indexes with a single field cannot be created. 108 109Args: 110 parent: string, The name of the database this index will apply to. For example: 111`projects/{project_id}/databases/{database_id}` (required) 112 body: object, The request body. (required) 113 The object takes the form of: 114 115{ # An index definition. 116 "fields": [ # The fields to index. 117 { # A field of an index. 118 "fieldPath": "A String", # The path of the field. Must match the field path specification described 119 # by google.firestore.v1beta1.Document.fields. 120 # Special field path `__name__` may be used by itself or at the end of a 121 # path. `__type__` may be used only at the end of path. 122 "mode": "A String", # The field's mode. 123 }, 124 ], 125 "state": "A String", # The state of the index. 126 # Output only. 127 "name": "A String", # The resource name of the index. 128 # Output only. 129 "collectionId": "A String", # The collection ID to which this index applies. Required. 130 } 131 132 x__xgafv: string, V1 error format. 133 Allowed values 134 1 - v1 error format 135 2 - v2 error format 136 137Returns: 138 An object of the form: 139 140 { # This resource represents a long-running operation that is the result of a 141 # network API call. 142 "metadata": { # Service-specific metadata associated with the operation. It typically 143 # contains progress information and common metadata such as create time. 144 # Some services might not provide such metadata. Any method that returns a 145 # long-running operation should document the metadata type, if any. 146 "a_key": "", # Properties of the object. Contains field @type with type URL. 147 }, 148 "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. 149 # different programming environments, including REST APIs and RPC APIs. It is 150 # used by [gRPC](https://github.com/grpc). The error model is designed to be: 151 # 152 # - Simple to use and understand for most users 153 # - Flexible enough to meet unexpected needs 154 # 155 # # Overview 156 # 157 # The `Status` message contains three pieces of data: error code, error 158 # message, and error details. The error code should be an enum value of 159 # google.rpc.Code, but it may accept additional error codes if needed. The 160 # error message should be a developer-facing English message that helps 161 # developers *understand* and *resolve* the error. If a localized user-facing 162 # error message is needed, put the localized message in the error details or 163 # localize it in the client. The optional error details may contain arbitrary 164 # information about the error. There is a predefined set of error detail types 165 # in the package `google.rpc` that can be used for common error conditions. 166 # 167 # # Language mapping 168 # 169 # The `Status` message is the logical representation of the error model, but it 170 # is not necessarily the actual wire format. When the `Status` message is 171 # exposed in different client libraries and different wire protocols, it can be 172 # mapped differently. For example, it will likely be mapped to some exceptions 173 # in Java, but more likely mapped to some error codes in C. 174 # 175 # # Other uses 176 # 177 # The error model and the `Status` message can be used in a variety of 178 # environments, either with or without APIs, to provide a 179 # consistent developer experience across different environments. 180 # 181 # Example uses of this error model include: 182 # 183 # - Partial errors. If a service needs to return partial errors to the client, 184 # it may embed the `Status` in the normal response to indicate the partial 185 # errors. 186 # 187 # - Workflow errors. A typical workflow has multiple steps. Each step may 188 # have a `Status` message for error reporting. 189 # 190 # - Batch operations. If a client uses batch request and batch response, the 191 # `Status` message should be used directly inside batch response, one for 192 # each error sub-response. 193 # 194 # - Asynchronous operations. If an API call embeds asynchronous operation 195 # results in its response, the status of those operations should be 196 # represented directly using the `Status` message. 197 # 198 # - Logging. If some API errors are stored in logs, the message `Status` could 199 # be used directly after any stripping needed for security/privacy reasons. 200 "message": "A String", # A developer-facing error message, which should be in English. Any 201 # user-facing error message should be localized and sent in the 202 # google.rpc.Status.details field, or localized by the client. 203 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 204 "details": [ # A list of messages that carry the error details. There is a common set of 205 # message types for APIs to use. 206 { 207 "a_key": "", # Properties of the object. Contains field @type with type URL. 208 }, 209 ], 210 }, 211 "done": True or False, # If the value is `false`, it means the operation is still in progress. 212 # If `true`, the operation is completed, and either `error` or `response` is 213 # available. 214 "response": { # The normal response of the operation in case of success. If the original 215 # method returns no data on success, such as `Delete`, the response is 216 # `google.protobuf.Empty`. If the original method is standard 217 # `Get`/`Create`/`Update`, the response should be the resource. For other 218 # methods, the response should have the type `XxxResponse`, where `Xxx` 219 # is the original method name. For example, if the original method name 220 # is `TakeSnapshot()`, the inferred response type is 221 # `TakeSnapshotResponse`. 222 "a_key": "", # Properties of the object. Contains field @type with type URL. 223 }, 224 "name": "A String", # The server-assigned name, which is only unique within the same service that 225 # originally returns it. If you use the default HTTP mapping, the 226 # `name` should have the format of `operations/some/unique/name`. 227 }</pre> 228</div> 229 230<div class="method"> 231 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 232 <pre>Deletes an index. 233 234Args: 235 name: string, The index name. For example: 236`projects/{project_id}/databases/{database_id}/indexes/{index_id}` (required) 237 x__xgafv: string, V1 error format. 238 Allowed values 239 1 - v1 error format 240 2 - v2 error format 241 242Returns: 243 An object of the form: 244 245 { # A generic empty message that you can re-use to avoid defining duplicated 246 # empty messages in your APIs. A typical example is to use it as the request 247 # or the response type of an API method. For instance: 248 # 249 # service Foo { 250 # rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); 251 # } 252 # 253 # The JSON representation for `Empty` is empty JSON object `{}`. 254 }</pre> 255</div> 256 257<div class="method"> 258 <code class="details" id="get">get(name, x__xgafv=None)</code> 259 <pre>Gets an index. 260 261Args: 262 name: string, The name of the index. For example: 263`projects/{project_id}/databases/{database_id}/indexes/{index_id}` (required) 264 x__xgafv: string, V1 error format. 265 Allowed values 266 1 - v1 error format 267 2 - v2 error format 268 269Returns: 270 An object of the form: 271 272 { # An index definition. 273 "fields": [ # The fields to index. 274 { # A field of an index. 275 "fieldPath": "A String", # The path of the field. Must match the field path specification described 276 # by google.firestore.v1beta1.Document.fields. 277 # Special field path `__name__` may be used by itself or at the end of a 278 # path. `__type__` may be used only at the end of path. 279 "mode": "A String", # The field's mode. 280 }, 281 ], 282 "state": "A String", # The state of the index. 283 # Output only. 284 "name": "A String", # The resource name of the index. 285 # Output only. 286 "collectionId": "A String", # The collection ID to which this index applies. Required. 287 }</pre> 288</div> 289 290<div class="method"> 291 <code class="details" id="list">list(parent, pageToken=None, x__xgafv=None, pageSize=None, filter=None)</code> 292 <pre>Lists the indexes that match the specified filters. 293 294Args: 295 parent: string, The database name. For example: 296`projects/{project_id}/databases/{database_id}` (required) 297 pageToken: string, The standard List page token. 298 x__xgafv: string, V1 error format. 299 Allowed values 300 1 - v1 error format 301 2 - v2 error format 302 pageSize: integer, The standard List page size. 303 filter: string, A parameter 304 305Returns: 306 An object of the form: 307 308 { # The response for FirestoreAdmin.ListIndexes. 309 "nextPageToken": "A String", # The standard List next-page token. 310 "indexes": [ # The indexes. 311 { # An index definition. 312 "fields": [ # The fields to index. 313 { # A field of an index. 314 "fieldPath": "A String", # The path of the field. Must match the field path specification described 315 # by google.firestore.v1beta1.Document.fields. 316 # Special field path `__name__` may be used by itself or at the end of a 317 # path. `__type__` may be used only at the end of path. 318 "mode": "A String", # The field's mode. 319 }, 320 ], 321 "state": "A String", # The state of the index. 322 # Output only. 323 "name": "A String", # The resource name of the index. 324 # Output only. 325 "collectionId": "A String", # The collection ID to which this index applies. Required. 326 }, 327 ], 328 }</pre> 329</div> 330 331<div class="method"> 332 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 333 <pre>Retrieves the next page of results. 334 335Args: 336 previous_request: The request for the previous page. (required) 337 previous_response: The response from the request for the previous page. (required) 338 339Returns: 340 A request object that you can call 'execute()' on to request the next 341 page. Returns None if there are no more items in the collection. 342 </pre> 343</div> 344 345</body></html>