Skip to content

Commit

Permalink
🦉 Updates from OwlBot post-processor
Browse files Browse the repository at this point in the history
  • Loading branch information
gcf-owl-bot[bot] committed Nov 30, 2023
1 parent 7a9b2a4 commit 2532bda
Show file tree
Hide file tree
Showing 161 changed files with 27,235 additions and 23,990 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -115,146 +115,19 @@
* <p>Note: close() needs to be called on the DatastoreAdminClient object to clean up resources such
* as threads. In the example above, try-with-resources is used, which automatically calls close().
*
* <table>
* <tr>
* <th>Method</th>
* <th>Description</th>
* <th>Method Variants</th>
* <tr>
* <td>ExportEntities</td>
* <td><p>Exports a copy of all or a subset of entities from Google Cloud Datastore
* to another storage system, such as Google Cloud Storage. Recent updates to
* entities may not be reflected in the export. The export occurs in the
* background and its progress can be monitored and managed via the
* Operation resource that is created. The output of an export may only be
* used once the associated operation is done. If an export operation is
* cancelled before completion it may leave partial data behind in Google
* Cloud Storage.</p></td>
* <td>
* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>
* <ul>
* <li>exportEntitiesAsync(ExportEntitiesRequest request)
* </ul>
* <p>Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.</p>
* <ul>
* <li>exportEntitiesAsync(String projectId, Map<String, String> labels, EntityFilter entityFilter, String outputUrlPrefix)
* </ul>
* <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>
* <ul>
* <li>exportEntitiesOperationCallable()
* <li>exportEntitiesCallable()
* </ul>
* </td>
* </tr>
* <tr>
* <td>ImportEntities</td>
* <td><p>Imports entities into Google Cloud Datastore. Existing entities with the
* same key are overwritten. The import occurs in the background and its
* progress can be monitored and managed via the Operation resource that is
* created. If an ImportEntities operation is cancelled, it is possible
* that a subset of the data has already been imported to Cloud Datastore.</p></td>
* <td>
* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>
* <ul>
* <li>importEntitiesAsync(ImportEntitiesRequest request)
* </ul>
* <p>Methods that return long-running operations have "Async" method variants that return `OperationFuture`, which is used to track polling of the service.</p>
* <ul>
* <li>importEntitiesAsync(String projectId, Map<String, String> labels, String inputUrl, EntityFilter entityFilter)
* </ul>
* <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>
* <ul>
* <li>importEntitiesOperationCallable()
* <li>importEntitiesCallable()
* </ul>
* </td>
* </tr>
* <tr>
* <td>CreateIndex</td>
* <td><p>Creates the specified index.
* A newly created index's initial state is `CREATING`. On completion of the
* returned [google.longrunning.Operation][google.longrunning.Operation], the
* state will be `READY`. If the index already exists, the call will return an
* `ALREADY_EXISTS` status.
* <p>The surface of this class includes several types of Java methods for each of the API's
* methods:
*
* 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][google.datastore.admin.v1.DatastoreAdmin.DeleteIndex], then
* re-creating the index with [create]
* [google.datastore.admin.v1.DatastoreAdmin.CreateIndex].
*
* Indexes with a single property cannot be created.</p></td>
* <td>
* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>
* <ul>
* <li>createIndexAsync(CreateIndexRequest request)
* </ul>
* <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>
* <ul>
* <li>createIndexOperationCallable()
* <li>createIndexCallable()
* </ul>
* </td>
* </tr>
* <tr>
* <td>DeleteIndex</td>
* <td><p>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][google.datastore.admin.v1.Index.State]. And on completion of the
* returned [google.longrunning.Operation][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][google.datastore.admin.v1.DatastoreAdmin.DeleteIndex] again.</p></td>
* <td>
* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>
* <ul>
* <li>deleteIndexAsync(DeleteIndexRequest request)
* </ul>
* <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>
* <ul>
* <li>deleteIndexOperationCallable()
* <li>deleteIndexCallable()
* </ul>
* </td>
* </tr>
* <tr>
* <td>GetIndex</td>
* <td><p>Gets an index.</p></td>
* <td>
* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>
* <ul>
* <li>getIndex(GetIndexRequest request)
* </ul>
* <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>
* <ul>
* <li>getIndexCallable()
* </ul>
* </td>
* </tr>
* <tr>
* <td>ListIndexes</td>
* <td><p>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></td>
* <td>
* <p>Request object method variants only take one parameter, a request object, which must be constructed before the call.</p>
* <ul>
* <li>listIndexes(ListIndexesRequest request)
* </ul>
* <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>
* <ul>
* <li>listIndexesPagedCallable()
* <li>listIndexesCallable()
* </ul>
* </td>
* </tr>
* </tr>
* </table>
* <ol>
* <li>A "flattened" method. With this type of method, the fields of the request type have been
* converted into function parameters. It may be the case that not all fields are available as
* parameters, and not every API method will have a flattened method entry point.
* <li>A "request object" method. This type of method only takes one parameter, a request object,
* which must be constructed before the call. Not every API method will have a request object
* method.
* <li>A "callable" method. This type of method takes no parameters and returns an immutable API
* callable object, which can be used to initiate calls to the service.
* </ol>
*
* <p>See the individual methods for example code.
*
Expand Down
Loading

0 comments on commit 2532bda

Please sign in to comment.