|
115 | 115 | * <p>Note: close() needs to be called on the DatastoreAdminClient object to clean up resources such |
116 | 116 | * as threads. In the example above, try-with-resources is used, which automatically calls close(). |
117 | 117 | * |
118 | | - * <table> |
119 | | - * <tr> |
120 | | - * <th>Method</th> |
121 | | - * <th>Description</th> |
122 | | - * <th>Method Variants</th> |
123 | | - * <tr> |
124 | | - * <td>ExportEntities</td> |
125 | | - * <td><p>Exports a copy of all or a subset of entities from Google Cloud Datastore |
126 | | - * to another storage system, such as Google Cloud Storage. Recent updates to |
127 | | - * entities may not be reflected in the export. The export occurs in the |
128 | | - * background and its progress can be monitored and managed via the |
129 | | - * Operation resource that is created. The output of an export may only be |
130 | | - * used once the associated operation is done. If an export operation is |
131 | | - * cancelled before completion it may leave partial data behind in Google |
132 | | - * Cloud Storage.</p></td> |
133 | | - * <td> |
134 | | - * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
135 | | - * <ul> |
136 | | - * <li>exportEntitiesAsync(ExportEntitiesRequest request) |
137 | | - * </ul> |
138 | | - * <p>Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.</p> |
139 | | - * <ul> |
140 | | - * <li>exportEntitiesAsync(String projectId, Map<String, String> labels, EntityFilter entityFilter, String outputUrlPrefix) |
141 | | - * </ul> |
142 | | - * <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p> |
143 | | - * <ul> |
144 | | - * <li>exportEntitiesOperationCallable() |
145 | | - * <li>exportEntitiesCallable() |
146 | | - * </ul> |
147 | | - * </td> |
148 | | - * </tr> |
149 | | - * <tr> |
150 | | - * <td>ImportEntities</td> |
151 | | - * <td><p>Imports entities into Google Cloud Datastore. Existing entities with the |
152 | | - * same key are overwritten. The import occurs in the background and its |
153 | | - * progress can be monitored and managed via the Operation resource that is |
154 | | - * created. If an ImportEntities operation is cancelled, it is possible |
155 | | - * that a subset of the data has already been imported to Cloud Datastore.</p></td> |
156 | | - * <td> |
157 | | - * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
158 | | - * <ul> |
159 | | - * <li>importEntitiesAsync(ImportEntitiesRequest request) |
160 | | - * </ul> |
161 | | - * <p>Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.</p> |
162 | | - * <ul> |
163 | | - * <li>importEntitiesAsync(String projectId, Map<String, String> labels, String inputUrl, EntityFilter entityFilter) |
164 | | - * </ul> |
165 | | - * <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p> |
166 | | - * <ul> |
167 | | - * <li>importEntitiesOperationCallable() |
168 | | - * <li>importEntitiesCallable() |
169 | | - * </ul> |
170 | | - * </td> |
171 | | - * </tr> |
172 | | - * <tr> |
173 | | - * <td>CreateIndex</td> |
174 | | - * <td><p>Creates the specified index. |
175 | | - * A newly created index's initial state is `CREATING`. On completion of the |
176 | | - * returned [google.longrunning.Operation][google.longrunning.Operation], the |
177 | | - * state will be `READY`. If the index already exists, the call will return an |
178 | | - * `ALREADY_EXISTS` status. |
| 118 | + * <p>The surface of this class includes several types of Java methods for each of the API's |
| 119 | + * methods: |
179 | 120 | * |
180 | | - * During index creation, the process could result in an error, in which |
181 | | - * case the index will move to the `ERROR` state. The process can be recovered |
182 | | - * by fixing the data that caused the error, removing the index with |
183 | | - * [delete][google.datastore.admin.v1.DatastoreAdmin.DeleteIndex], then |
184 | | - * re-creating the index with [create] |
185 | | - * [google.datastore.admin.v1.DatastoreAdmin.CreateIndex]. |
186 | | - * |
187 | | - * Indexes with a single property cannot be created.</p></td> |
188 | | - * <td> |
189 | | - * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
190 | | - * <ul> |
191 | | - * <li>createIndexAsync(CreateIndexRequest request) |
192 | | - * </ul> |
193 | | - * <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p> |
194 | | - * <ul> |
195 | | - * <li>createIndexOperationCallable() |
196 | | - * <li>createIndexCallable() |
197 | | - * </ul> |
198 | | - * </td> |
199 | | - * </tr> |
200 | | - * <tr> |
201 | | - * <td>DeleteIndex</td> |
202 | | - * <td><p>Deletes an existing index. |
203 | | - * An index can only be deleted if it is in a `READY` or `ERROR` state. On |
204 | | - * successful execution of the request, the index will be in a `DELETING` |
205 | | - * [state][google.datastore.admin.v1.Index.State]. And on completion of the |
206 | | - * returned [google.longrunning.Operation][google.longrunning.Operation], the |
207 | | - * index will be removed. |
208 | | - * |
209 | | - * During index deletion, the process could result in an error, in which |
210 | | - * case the index will move to the `ERROR` state. The process can be recovered |
211 | | - * by fixing the data that caused the error, followed by calling |
212 | | - * [delete][google.datastore.admin.v1.DatastoreAdmin.DeleteIndex] again.</p></td> |
213 | | - * <td> |
214 | | - * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
215 | | - * <ul> |
216 | | - * <li>deleteIndexAsync(DeleteIndexRequest request) |
217 | | - * </ul> |
218 | | - * <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p> |
219 | | - * <ul> |
220 | | - * <li>deleteIndexOperationCallable() |
221 | | - * <li>deleteIndexCallable() |
222 | | - * </ul> |
223 | | - * </td> |
224 | | - * </tr> |
225 | | - * <tr> |
226 | | - * <td>GetIndex</td> |
227 | | - * <td><p>Gets an index.</p></td> |
228 | | - * <td> |
229 | | - * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
230 | | - * <ul> |
231 | | - * <li>getIndex(GetIndexRequest request) |
232 | | - * </ul> |
233 | | - * <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p> |
234 | | - * <ul> |
235 | | - * <li>getIndexCallable() |
236 | | - * </ul> |
237 | | - * </td> |
238 | | - * </tr> |
239 | | - * <tr> |
240 | | - * <td>ListIndexes</td> |
241 | | - * <td><p>Lists the indexes that match the specified filters. Datastore uses an |
242 | | - * eventually consistent query to fetch the list of indexes and may |
243 | | - * occasionally return stale results.</p></td> |
244 | | - * <td> |
245 | | - * <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p> |
246 | | - * <ul> |
247 | | - * <li>listIndexes(ListIndexesRequest request) |
248 | | - * </ul> |
249 | | - * <p>Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.</p> |
250 | | - * <ul> |
251 | | - * <li>listIndexesPagedCallable() |
252 | | - * <li>listIndexesCallable() |
253 | | - * </ul> |
254 | | - * </td> |
255 | | - * </tr> |
256 | | - * </tr> |
257 | | - * </table> |
| 121 | + * <ol> |
| 122 | + * <li>A "flattened" method. With this type of method, the fields of the request type have been |
| 123 | + * converted into function parameters. It may be the case that not all fields are available as |
| 124 | + * parameters, and not every API method will have a flattened method entry point. |
| 125 | + * <li>A "request object" method. This type of method only takes one parameter, a request object, |
| 126 | + * which must be constructed before the call. Not every API method will have a request object |
| 127 | + * method. |
| 128 | + * <li>A "callable" method. This type of method takes no parameters and returns an immutable API |
| 129 | + * callable object, which can be used to initiate calls to the service. |
| 130 | + * </ol> |
258 | 131 | * |
259 | 132 | * <p>See the individual methods for example code. |
260 | 133 | * |
|
0 commit comments