• Home
  • Line#
  • Scopes#
  • Navigate#
  • Raw
  • Download
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="#get">get(projectId, indexId, x__xgafv=None)</a></code></p>
79<p class="firstline">Gets an index.</p>
80<p class="toc_element">
81  <code><a href="#list">list(projectId, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</a></code></p>
82<p class="firstline">Lists the indexes that match the specified filters.  Datastore uses an</p>
83<p class="toc_element">
84  <code><a href="#list_next">list_next(previous_request, previous_response)</a></code></p>
85<p class="firstline">Retrieves the next page of results.</p>
86<h3>Method Details</h3>
87<div class="method">
88    <code class="details" id="get">get(projectId, indexId, x__xgafv=None)</code>
89  <pre>Gets an index.
90
91Args:
92  projectId: string, Project ID against which to make the request. (required)
93  indexId: string, The resource ID of the index to get. (required)
94  x__xgafv: string, V1 error format.
95    Allowed values
96      1 - v1 error format
97      2 - v2 error format
98
99Returns:
100  An object of the form:
101
102    { # A minimal index definition.
103    "kind": "A String", # The entity kind to which this index applies.
104        # Required.
105    "projectId": "A String", # Project ID.
106        # Output only.
107    "indexId": "A String", # The resource ID of the index.
108        # Output only.
109    "state": "A String", # The state of the index.
110        # Output only.
111    "ancestor": "A String", # The index's ancestor mode.  Must not be ANCESTOR_MODE_UNSPECIFIED.
112        # Required.
113    "properties": [ # An ordered sequence of property names and their index attributes.
114        # Required.
115      { # A property of an index.
116        "direction": "A String", # The indexed property's direction.  Must not be DIRECTION_UNSPECIFIED.
117            # Required.
118        "name": "A String", # The property name to index.
119            # Required.
120      },
121    ],
122  }</pre>
123</div>
124
125<div class="method">
126    <code class="details" id="list">list(projectId, pageSize=None, pageToken=None, x__xgafv=None, filter=None)</code>
127  <pre>Lists the indexes that match the specified filters.  Datastore uses an
128eventually consistent query to fetch the list of indexes and may
129occasionally return stale results.
130
131Args:
132  projectId: string, Project ID against which to make the request. (required)
133  pageSize: integer, The maximum number of items to return.  If zero, then all results will be
134returned.
135  pageToken: string, The next_page_token value returned from a previous List request, if any.
136  x__xgafv: string, V1 error format.
137    Allowed values
138      1 - v1 error format
139      2 - v2 error format
140  filter: string, A parameter
141
142Returns:
143  An object of the form:
144
145    { # The response for
146      # google.datastore.admin.v1.DatastoreAdmin.ListIndexes.
147    "nextPageToken": "A String", # The standard List next-page token.
148    "indexes": [ # The indexes.
149      { # A minimal index definition.
150        "kind": "A String", # The entity kind to which this index applies.
151            # Required.
152        "projectId": "A String", # Project ID.
153            # Output only.
154        "indexId": "A String", # The resource ID of the index.
155            # Output only.
156        "state": "A String", # The state of the index.
157            # Output only.
158        "ancestor": "A String", # The index's ancestor mode.  Must not be ANCESTOR_MODE_UNSPECIFIED.
159            # Required.
160        "properties": [ # An ordered sequence of property names and their index attributes.
161            # Required.
162          { # A property of an index.
163            "direction": "A String", # The indexed property's direction.  Must not be DIRECTION_UNSPECIFIED.
164                # Required.
165            "name": "A String", # The property name to index.
166                # Required.
167          },
168        ],
169      },
170    ],
171  }</pre>
172</div>
173
174<div class="method">
175    <code class="details" id="list_next">list_next(previous_request, previous_response)</code>
176  <pre>Retrieves the next page of results.
177
178Args:
179  previous_request: The request for the previous page. (required)
180  previous_response: The response from the request for the previous page. (required)
181
182Returns:
183  A request object that you can call 'execute()' on to request the next
184  page. Returns None if there are no more items in the collection.
185    </pre>
186</div>
187
188</body></html>