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="datastore_v1.html">Cloud Datastore API</a> . <a href="datastore_v1.projects.html">projects</a> . <a href="datastore_v1.projects.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(projectId, 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 index 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 property cannot be created.</p> 83<p class="toc_element"> 84 <code><a href="#delete">delete(projectId, indexId, x__xgafv=None)</a></code></p> 85<p class="firstline">Deletes an existing index. An index can only be deleted if it is in a `READY` or `ERROR` state. On successful execution of the request, the index will be in a `DELETING` state. And on completion of the returned google.longrunning.Operation, the index will be removed. During index deletion, 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, followed by calling delete again.</p> 86<p class="toc_element"> 87 <code><a href="#get">get(projectId, indexId, 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(projectId, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p> 91<p class="firstline">Lists the indexes that match the specified filters. Datastore uses an eventually consistent query to fetch the list of indexes and may occasionally return stale results.</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(projectId, 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 index 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 property cannot be created. 104 105Args: 106 projectId: string, Project ID against which to make the request. (required) 107 body: object, The request body. 108 The object takes the form of: 109 110{ # Datastore composite index definition. 111 "ancestor": "A String", # Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED. 112 "indexId": "A String", # Output only. The resource ID of the index. 113 "kind": "A String", # Required. The entity kind to which this index applies. 114 "projectId": "A String", # Output only. Project ID. 115 "properties": [ # Required. An ordered sequence of property names and their index attributes. 116 { # A property of an index. 117 "direction": "A String", # Required. The indexed property's direction. Must not be DIRECTION_UNSPECIFIED. 118 "name": "A String", # Required. The property name to index. 119 }, 120 ], 121 "state": "A String", # Output only. The state of the index. 122} 123 124 x__xgafv: string, V1 error format. 125 Allowed values 126 1 - v1 error format 127 2 - v2 error format 128 129Returns: 130 An object of the form: 131 132 { # This resource represents a long-running operation that is the result of a network API call. 133 "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. 134 "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. 135 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 136 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 137 { 138 "a_key": "", # Properties of the object. Contains field @type with type URL. 139 }, 140 ], 141 "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. 142 }, 143 "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. 144 "a_key": "", # Properties of the object. Contains field @type with type URL. 145 }, 146 "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}`. 147 "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`. 148 "a_key": "", # Properties of the object. Contains field @type with type URL. 149 }, 150}</pre> 151</div> 152 153<div class="method"> 154 <code class="details" id="delete">delete(projectId, indexId, x__xgafv=None)</code> 155 <pre>Deletes an existing index. An index can only be deleted if it is in a `READY` or `ERROR` state. On successful execution of the request, the index will be in a `DELETING` state. And on completion of the returned google.longrunning.Operation, the index will be removed. During index deletion, 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, followed by calling delete again. 156 157Args: 158 projectId: string, Project ID against which to make the request. (required) 159 indexId: string, The resource ID of the index to delete. (required) 160 x__xgafv: string, V1 error format. 161 Allowed values 162 1 - v1 error format 163 2 - v2 error format 164 165Returns: 166 An object of the form: 167 168 { # This resource represents a long-running operation that is the result of a network API call. 169 "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. 170 "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. 171 "code": 42, # The status code, which should be an enum value of google.rpc.Code. 172 "details": [ # A list of messages that carry the error details. There is a common set of message types for APIs to use. 173 { 174 "a_key": "", # Properties of the object. Contains field @type with type URL. 175 }, 176 ], 177 "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. 178 }, 179 "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. 180 "a_key": "", # Properties of the object. Contains field @type with type URL. 181 }, 182 "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}`. 183 "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`. 184 "a_key": "", # Properties of the object. Contains field @type with type URL. 185 }, 186}</pre> 187</div> 188 189<div class="method"> 190 <code class="details" id="get">get(projectId, indexId, x__xgafv=None)</code> 191 <pre>Gets an index. 192 193Args: 194 projectId: string, Project ID against which to make the request. (required) 195 indexId: string, The resource ID of the index to get. (required) 196 x__xgafv: string, V1 error format. 197 Allowed values 198 1 - v1 error format 199 2 - v2 error format 200 201Returns: 202 An object of the form: 203 204 { # Datastore composite index definition. 205 "ancestor": "A String", # Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED. 206 "indexId": "A String", # Output only. The resource ID of the index. 207 "kind": "A String", # Required. The entity kind to which this index applies. 208 "projectId": "A String", # Output only. Project ID. 209 "properties": [ # Required. An ordered sequence of property names and their index attributes. 210 { # A property of an index. 211 "direction": "A String", # Required. The indexed property's direction. Must not be DIRECTION_UNSPECIFIED. 212 "name": "A String", # Required. The property name to index. 213 }, 214 ], 215 "state": "A String", # Output only. The state of the index. 216}</pre> 217</div> 218 219<div class="method"> 220 <code class="details" id="list">list(projectId, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code> 221 <pre>Lists the indexes that match the specified filters. Datastore uses an eventually consistent query to fetch the list of indexes and may occasionally return stale results. 222 223Args: 224 projectId: string, Project ID against which to make the request. (required) 225 filter: string, A parameter 226 pageSize: integer, The maximum number of items to return. If zero, then all results will be returned. 227 pageToken: string, The next_page_token value returned from a previous List request, if any. 228 x__xgafv: string, V1 error format. 229 Allowed values 230 1 - v1 error format 231 2 - v2 error format 232 233Returns: 234 An object of the form: 235 236 { # The response for google.datastore.admin.v1.DatastoreAdmin.ListIndexes. 237 "indexes": [ # The indexes. 238 { # Datastore composite index definition. 239 "ancestor": "A String", # Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED. 240 "indexId": "A String", # Output only. The resource ID of the index. 241 "kind": "A String", # Required. The entity kind to which this index applies. 242 "projectId": "A String", # Output only. Project ID. 243 "properties": [ # Required. An ordered sequence of property names and their index attributes. 244 { # A property of an index. 245 "direction": "A String", # Required. The indexed property's direction. Must not be DIRECTION_UNSPECIFIED. 246 "name": "A String", # Required. The property name to index. 247 }, 248 ], 249 "state": "A String", # Output only. The state of the index. 250 }, 251 ], 252 "nextPageToken": "A String", # The standard List next-page token. 253}</pre> 254</div> 255 256<div class="method"> 257 <code class="details" id="list_next">list_next(previous_request, previous_response)</code> 258 <pre>Retrieves the next page of results. 259 260Args: 261 previous_request: The request for the previous page. (required) 262 previous_response: The response from the request for the previous page. (required) 263 264Returns: 265 A request object that you can call 'execute()' on to request the next 266 page. Returns None if there are no more items in the collection. 267 </pre> 268</div> 269 270</body></html>