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_v1beta2.html">Cloud Firestore API</a> . <a href="firestore_v1beta2.projects.html">projects</a> . <a href="firestore_v1beta2.projects.databases.html">databases</a> . <a href="firestore_v1beta2.projects.databases.collectionGroups.html">collectionGroups</a> . <a href="firestore_v1beta2.projects.databases.collectionGroups.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 a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(name, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes a composite 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 a composite 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 composite indexes.</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 a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata. 104 105Args: 106 parent: string, A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` (required) 107 body: object, The request body. 108 The object takes the form of: 109 110{ # Cloud Firestore indexes enable simple and complex queries against documents in a database. 111 "fields": [ # The fields supported by this index. For composite indexes, this is always 2 or more fields. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field. 112 { # A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed. 113 "arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s. 114 "fieldPath": "A String", # Can be __name__. For single field indexes, this must match the name of the field or may be omitted. 115 "order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=. 116 }, 117 ], 118 "name": "A String", # Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty. 119 "queryScope": "A String", # Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index. 120 "state": "A String", # Output only. The serving state of the index. 121} 122 123 x__xgafv: string, V1 error format. 124 Allowed values 125 1 - v1 error format 126 2 - v2 error format 127 128Returns: 129 An object of the form: 130 131 { # This resource represents a long-running operation that is the result of a network API call. 132 "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. 133 "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. 134 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 135 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 136 { 137 "a_key": "", # Properties of the object. Contains field @type with type URL. 138 }, 139 ], 140 "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. 141 }, 142 "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. 143 "a_key": "", # Properties of the object. Contains field @type with type URL. 144 }, 145 "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}`. 146 "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`. 147 "a_key": "", # Properties of the object. Contains field @type with type URL. 148 }, 149}</pre> 150</div> 151 152<div class="method"> 153 <code class="details" id="delete">delete(name, x__xgafv=None)</code> 154 <pre>Deletes a composite index. 155 156Args: 157 name: string, A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` (required) 158 x__xgafv: string, V1 error format. 159 Allowed values 160 1 - v1 error format 161 2 - v2 error format 162 163Returns: 164 An object of the form: 165 166 { # 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 `{}`. 167}</pre> 168</div> 169 170<div class="method"> 171 <code class="details" id="get">get(name, x__xgafv=None)</code> 172 <pre>Gets a composite index. 173 174Args: 175 name: string, A name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}` (required) 176 x__xgafv: string, V1 error format. 177 Allowed values 178 1 - v1 error format 179 2 - v2 error format 180 181Returns: 182 An object of the form: 183 184 { # Cloud Firestore indexes enable simple and complex queries against documents in a database. 185 "fields": [ # The fields supported by this index. For composite indexes, this is always 2 or more fields. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field. 186 { # A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed. 187 "arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s. 188 "fieldPath": "A String", # Can be __name__. For single field indexes, this must match the name of the field or may be omitted. 189 "order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=. 190 }, 191 ], 192 "name": "A String", # Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty. 193 "queryScope": "A String", # Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index. 194 "state": "A String", # Output only. The serving state of the index. 195}</pre> 196</div> 197 198<div class="method"> 199 <code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 200 <pre>Lists composite indexes. 201 202Args: 203 parent: string, A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` (required) 204 filter: string, The filter to apply to list results. 205 pageSize: integer, The number of results to return. 206 pageToken: string, A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results. 207 x__xgafv: string, V1 error format. 208 Allowed values 209 1 - v1 error format 210 2 - v2 error format 211 212Returns: 213 An object of the form: 214 215 { # The response for FirestoreAdmin.ListIndexes. 216 "indexes": [ # The requested indexes. 217 { # Cloud Firestore indexes enable simple and complex queries against documents in a database. 218 "fields": [ # The fields supported by this index. For composite indexes, this is always 2 or more fields. The last field entry is always for the field path `__name__`. If, on creation, `__name__` was not specified as the last field, it will be added automatically with the same direction as that of the last field defined. If the final field in a composite index is not directional, the `__name__` will be ordered ASCENDING (unless explicitly specified). For single field indexes, this will always be exactly one entry with a field path equal to the field path of the associated field. 219 { # A field in an index. The field_path describes which field is indexed, the value_mode describes how the field value is indexed. 220 "arrayConfig": "A String", # Indicates that this field supports operations on `array_value`s. 221 "fieldPath": "A String", # Can be __name__. For single field indexes, this must match the name of the field or may be omitted. 222 "order": "A String", # Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=. 223 }, 224 ], 225 "name": "A String", # Output only. A server defined name for this index. The form of this name for composite indexes will be: `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{composite_index_id}` For single field indexes, this field will be empty. 226 "queryScope": "A String", # Indexes with a collection query scope specified allow queries against a collection that is the child of a specific document, specified at query time, and that has the same collection id. Indexes with a collection group query scope specified allow queries against all collections descended from a specific document, specified at query time, and that have the same collection id as this index. 227 "state": "A String", # Output only. The serving state of the index. 228 }, 229 ], 230 "nextPageToken": "A String", # A page token that may be used to request another page of results. If blank, this is the last page. 231}</pre> 232</div> 233 234<div class="method"> 235 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 236 <pre>Retrieves the next page of results. 237 238Args: 239 previous_request: The request for the previous page. (required) 240 previous_response: The response from the request for the previous page. (required) 241 242Returns: 243 A request object that you can call 'execute()' on to request the next 244 page. Returns None if there are no more items in the collection. 245 </pre> 246</div> 247 248</body></html>