| <html><body> | |
| <style> | |
| body, h1, h2, h3, div, span, p, pre, a { | |
| margin: 0; | |
| padding: 0; | |
| border: 0; | |
| font-weight: inherit; | |
| font-style: inherit; | |
| font-size: 100%; | |
| font-family: inherit; | |
| vertical-align: baseline; | |
| } | |
| body { | |
| font-size: 13px; | |
| padding: 1em; | |
| } | |
| h1 { | |
| font-size: 26px; | |
| margin-bottom: 1em; | |
| } | |
| h2 { | |
| font-size: 24px; | |
| margin-bottom: 1em; | |
| } | |
| h3 { | |
| font-size: 20px; | |
| margin-bottom: 1em; | |
| margin-top: 1em; | |
| } | |
| pre, code { | |
| line-height: 1.5; | |
| font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace; | |
| } | |
| pre { | |
| margin-top: 0.5em; | |
| } | |
| h1, h2, h3, p { | |
| font-family: Arial, sans serif; | |
| } | |
| h1, h2, h3 { | |
| border-bottom: solid #CCC 1px; | |
| } | |
| .toc_element { | |
| margin-top: 0.5em; | |
| } | |
| .firstline { | |
| margin-left: 2 em; | |
| } | |
| .method { | |
| margin-top: 1em; | |
| border: solid 1px #CCC; | |
| padding: 1em; | |
| background: #EEE; | |
| } | |
| .details { | |
| font-weight: bold; | |
| font-size: 14px; | |
| } | |
| </style> | |
| <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> | |
| <h2>Instance Methods</h2> | |
| <p class="toc_element"> | |
| <code><a href="#get">get(projectId, indexId, x__xgafv=None)</a></code></p> | |
| <p class="firstline">Gets an index.</p> | |
| <p class="toc_element"> | |
| <code><a href="#list">list(projectId, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</a></code></p> | |
| <p class="firstline">Lists the indexes that match the specified filters. Datastore uses an</p> | |
| <p class="toc_element"> | |
| <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p> | |
| <p class="firstline">Retrieves the next page of results.</p> | |
| <h3>Method Details</h3> | |
| <div class="method"> | |
| <code class="details" id="get">get(projectId, indexId, x__xgafv=None)</code> | |
| <pre>Gets an index. | |
| Args: | |
| projectId: string, Project ID against which to make the request. (required) | |
| indexId: string, The resource ID of the index to get. (required) | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| Returns: | |
| An object of the form: | |
| { # A minimal index definition. | |
| "kind": "A String", # The entity kind to which this index applies. | |
| # Required. | |
| "projectId": "A String", # Project ID. | |
| # Output only. | |
| "indexId": "A String", # The resource ID of the index. | |
| # Output only. | |
| "state": "A String", # The state of the index. | |
| # Output only. | |
| "ancestor": "A String", # The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED. | |
| # Required. | |
| "properties": [ # An ordered sequence of property names and their index attributes. | |
| # Required. | |
| { # A property of an index. | |
| "direction": "A String", # The indexed property's direction. Must not be DIRECTION_UNSPECIFIED. | |
| # Required. | |
| "name": "A String", # The property name to index. | |
| # Required. | |
| }, | |
| ], | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list">list(projectId, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code> | |
| <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. | |
| Args: | |
| projectId: string, Project ID against which to make the request. (required) | |
| pageSize: integer, The maximum number of items to return. If zero, then all results will be | |
| returned. | |
| pageToken: string, The next_page_token value returned from a previous List request, if any. | |
| x__xgafv: string, V1 error format. | |
| Allowed values | |
| 1 - v1 error format | |
| 2 - v2 error format | |
| filter: string, A parameter | |
| Returns: | |
| An object of the form: | |
| { # The response for | |
| # google.datastore.admin.v1.DatastoreAdmin.ListIndexes. | |
| "nextPageToken": "A String", # The standard List next-page token. | |
| "indexes": [ # The indexes. | |
| { # A minimal index definition. | |
| "kind": "A String", # The entity kind to which this index applies. | |
| # Required. | |
| "projectId": "A String", # Project ID. | |
| # Output only. | |
| "indexId": "A String", # The resource ID of the index. | |
| # Output only. | |
| "state": "A String", # The state of the index. | |
| # Output only. | |
| "ancestor": "A String", # The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED. | |
| # Required. | |
| "properties": [ # An ordered sequence of property names and their index attributes. | |
| # Required. | |
| { # A property of an index. | |
| "direction": "A String", # The indexed property's direction. Must not be DIRECTION_UNSPECIFIED. | |
| # Required. | |
| "name": "A String", # The property name to index. | |
| # Required. | |
| }, | |
| ], | |
| }, | |
| ], | |
| }</pre> | |
| </div> | |
| <div class="method"> | |
| <code class="details" id="list_next">list_next(previous_request, previous_response)</code> | |
| <pre>Retrieves the next page of results. | |
| Args: | |
| previous_request: The request for the previous page. (required) | |
| previous_response: The response from the request for the previous page. (required) | |
| Returns: | |
| A request object that you can call 'execute()' on to request the next | |
| page. Returns None if there are no more items in the collection. | |
| </pre> | |
| </div> | |
| </body></html> |