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="#close">close()</a></code></p> 79<p class="firstline">Close httplib2 connections.</p> 80<p class="toc_element"> 81 <code><a href="#create">create(parent, body=None, x__xgafv=None)</a></code></p> 82<p class="firstline">Creates the specified index. A newly created index's initial state is `CREATING`. On completion of the returned google.longrunning.Operation, the state will be `READY`. If the index already exists, the call will return an `ALREADY_EXISTS` status. During creation, the process could result in an error, in which case the index will move to the `ERROR` state. The process can be recovered by fixing the data that caused the error, removing the index with delete, then re-creating the index with create. Indexes with a single field cannot be created.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes an index.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(name, x__xgafv=None)</a></code></p> 88<p class="firstline">Gets an index.</p> 89<p class="toc_element"> 90 <code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists the indexes that match the specified filters.</p> 92<p class="toc_element"> 93 <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> 94<p class="firstline">Retrieves the next page of results.</p> 95<h3>Method Details</h3> 96<div class="method"> 97 <code class="details" id="close">close()</code> 98 <pre>Close httplib2 connections.</pre> 99</div> 100 101<div class="method"> 102 <code class="details" id="create">create(parent, body=None, x__xgafv=None)</code> 103 <pre>Creates the specified index. A newly created index's initial state is `CREATING`. On completion of the returned google.longrunning.Operation, the state will be `READY`. If the index already exists, the call will return an `ALREADY_EXISTS` status. During creation, the process could result in an error, in which case the index will move to the `ERROR` state. The process can be recovered by fixing the data that caused the error, removing the index with delete, then re-creating the index with create. Indexes with a single field cannot be created. 104 105Args: 106 parent: string, The name of the database this index will apply to. For example: `projects/{project_id}/databases/{database_id}` (required) 107 body: object, The request body. 108 The object takes the form of: 109 110{ # An index definition. 111 "collectionId": "A String", # The collection ID to which this index applies. Required. 112 "fields": [ # The fields to index. 113 { # A field of an index. 114 "fieldPath": "A String", # The path of the field. Must match the field path specification described by google.firestore.v1beta1.Document.fields. Special field path `__name__` may be used by itself or at the end of a path. `__type__` may be used only at the end of path. 115 "mode": "A String", # The field's mode. 116 }, 117 ], 118 "name": "A String", # The resource name of the index. Output only. 119 "state": "A String", # The state of the index. Output only. 120} 121 122 x__xgafv: string, V1 error format. 123 Allowed values 124 1 - v1 error format 125 2 - v2 error format 126 127Returns: 128 An object of the form: 129 130 { # This resource represents a long-running operation that is the result of a network API call. 131 "done": True or False, # If the value is `false`, it means the operation is still in progress. If `true`, the operation is completed, and either `error` or `response` is available. 132 "error": { # The `Status` type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by [gRPC](https://github.com/grpc). Each `Status` message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the [API Design Guide](https://cloud.google.com/apis/design/errors). # The error result of the operation in case of failure or cancellation. 133 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 134 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 135 { 136 "a_key": "", # Properties of the object. Contains field @type with type URL. 137 }, 138 ], 139 "message": "A String", # A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client. 140 }, 141 "metadata": { # Service-specific metadata associated with the operation. It typically contains progress information and common metadata such as create time. Some services might not provide such metadata. Any method that returns a long-running operation should document the metadata type, if any. 142 "a_key": "", # Properties of the object. Contains field @type with type URL. 143 }, 144 "name": "A String", # The server-assigned name, which is only unique within the same service that originally returns it. If you use the default HTTP mapping, the `name` should be a resource name ending with `operations/{unique_id}`. 145 "response": { # The normal response of the operation in case of success. If the original method returns no data on success, such as `Delete`, the response is `google.protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, the response should be the resource. For other methods, the response should have the type `XxxResponse`, where `Xxx` is the original method name. For example, if the original method name is `TakeSnapshot()`, the inferred response type is `TakeSnapshotResponse`. 146 "a_key": "", # Properties of the object. Contains field @type with type URL. 147 }, 148}</pre> 149</div> 150 151<div class="method"> 152 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 153 <pre>Deletes an index. 154 155Args: 156 name: string, The index name. For example: `projects/{project_id}/databases/{database_id}/indexes/{index_id}` (required) 157 x__xgafv: string, V1 error format. 158 Allowed values 159 1 - v1 error format 160 2 - v2 error format 161 162Returns: 163 An object of the form: 164 165 { # A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); } The JSON representation for `Empty` is empty JSON object `{}`. 166}</pre> 167</div> 168 169<div class="method"> 170 <code class="details" id="get">get(name, x__xgafv=None)</code> 171 <pre>Gets an index. 172 173Args: 174 name: string, The name of the index. For example: `projects/{project_id}/databases/{database_id}/indexes/{index_id}` (required) 175 x__xgafv: string, V1 error format. 176 Allowed values 177 1 - v1 error format 178 2 - v2 error format 179 180Returns: 181 An object of the form: 182 183 { # An index definition. 184 "collectionId": "A String", # The collection ID to which this index applies. Required. 185 "fields": [ # The fields to index. 186 { # A field of an index. 187 "fieldPath": "A String", # The path of the field. Must match the field path specification described by google.firestore.v1beta1.Document.fields. Special field path `__name__` may be used by itself or at the end of a path. `__type__` may be used only at the end of path. 188 "mode": "A String", # The field's mode. 189 }, 190 ], 191 "name": "A String", # The resource name of the index. Output only. 192 "state": "A String", # The state of the index. Output only. 193}</pre> 194</div> 195 196<div class="method"> 197 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 198 <pre>Lists the indexes that match the specified filters. 199 200Args: 201 parent: string, The database name. For example: `projects/{project_id}/databases/{database_id}` (required) 202 filter: string, A parameter 203 pageSize: integer, The standard List page size. 204 pageToken: string, The standard List page token. 205 x__xgafv: string, V1 error format. 206 Allowed values 207 1 - v1 error format 208 2 - v2 error format 209 210Returns: 211 An object of the form: 212 213 { # The response for FirestoreAdmin.ListIndexes. 214 "indexes": [ # The indexes. 215 { # An index definition. 216 "collectionId": "A String", # The collection ID to which this index applies. Required. 217 "fields": [ # The fields to index. 218 { # A field of an index. 219 "fieldPath": "A String", # The path of the field. Must match the field path specification described by google.firestore.v1beta1.Document.fields. Special field path `__name__` may be used by itself or at the end of a path. `__type__` may be used only at the end of path. 220 "mode": "A String", # The field's mode. 221 }, 222 ], 223 "name": "A String", # The resource name of the index. Output only. 224 "state": "A String", # The state of the index. Output only. 225 }, 226 ], 227 "nextPageToken": "A String", # The standard List next-page token. 228}</pre> 229</div> 230 231<div class="method"> 232 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 233 <pre>Retrieves the next page of results. 234 235Args: 236 previous_request: The request for the previous page. (required) 237 previous_response: The response from the request for the previous page. (required) 238 239Returns: 240 A request object that you can call 'execute()' on to request the next 241 page. Returns None if there are no more items in the collection. 242 </pre> 243</div> 244 245</body></html>