Skip to content

Address API review feedback #11645

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
sima-zhu merged 3 commits into from
Jun 2, 2020
Merged

Address API review feedback #11645

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
d717549
Address API review feedback
sima-zhu Jun 1, 2020
88409bb
Merge branch 'master' of https://github.com/Azure/azure-sdk-for-java …
sima-zhu Jun 1, 2020
3601e31
Fixed the service method
sima-zhu Jun 1, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 7 additions & 0 deletions eng/code-quality-reports/src/main/resources/checkstyle/checkstyle-suppressions.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -371,6 +371,13 @@
files=".*[/\\]search[/\\]documents[/\\]models[/\\]((?!(CoordinateSystem|GeoPoint|IndexBatch|ValueFacetResult|RangeFacetResult|ComplexField|SearchableField|SimpleField|SearchFieldBase|IndexBatchException|ScoringParameter)).*)"/>
<suppress checks="GoodLoggingCheck" files="com.azure.search.documents.implementation.util.PrivateFieldAccessHelper.java"/>

<!-- Removed this rule after the issue gets fixed: https://github.com/Azure/azure-sdk-for-java/issues/11651-->
<suppress checks="com.azure.tools.checkstyle.checks.ServiceClientCheck" files="com.azure.search.documents.SearchAsyncClient.java"/>
<suppress checks="com.azure.tools.checkstyle.checks.ServiceClientCheck" files="com.azure.search.documents.SearchClient.java"/>
<suppress checks="com.azure.tools.checkstyle.checks.ServiceClientCheck" files="com.azure.search.documents.indexes.SearchIndexClient.java"/>
<suppress checks="com.azure.tools.checkstyle.checks.ServiceClientCheck" files="com.azure.search.documents.indexes.SearchIndexAsyncClient.java"/>
<!-- <suppress checks="com.azure.tools.checkstyle.checks.ServiceClientCheck" files="com.azure.search.documents.SearchAsyncClient.java"/>-->

<!-- Suppress external dependency check for jacksonwrapper overriding deserialize method -->
<suppress checks="com.azure.tools.checkstyle.checks.ExternalDependencyExposedCheck"
files="com.azure.core.implementation.serializer.jsonwrapper.jacksonwrapper.JacksonDeserializer.java"/>
Expand Down
34 changes: 21 additions & 13 deletions ...ch/azure-search-documents/src/main/java/com/azure/search/documents/SearchAsyncClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,15 +3,19 @@

package com.azure.search.documents;

import com.azure.core.annotation.ReturnType;
import com.azure.core.annotation.ServiceClient;
import com.azure.core.annotation.ServiceMethod;
import com.azure.core.http.HttpPipeline;
import com.azure.core.http.rest.Response;
import com.azure.core.http.rest.SimpleResponse;
import com.azure.core.util.Context;
import com.azure.core.util.logging.ClientLogger;
import com.azure.core.util.serializer.JacksonAdapter;
import com.azure.core.util.serializer.SerializerAdapter;
import com.azure.search.documents.implementation.SearchIndexRestClientBuilder;
import com.azure.search.documents.implementation.SearchIndexRestClientImpl;
import com.azure.search.documents.implementation.SerializationUtil;
import com.azure.search.documents.implementation.converters.AutocompleteModeConverter;
import com.azure.search.documents.implementation.converters.IndexBatchBaseConverter;
import com.azure.search.documents.implementation.converters.IndexDocumentsResultConverter;
Expand All @@ -25,13 +29,11 @@
import com.azure.search.documents.implementation.util.DocumentResponseConversions;
import com.azure.search.documents.implementation.util.MappingUtils;
import com.azure.search.documents.implementation.util.SuggestOptionsHandler;
import com.azure.search.documents.implementation.SearchIndexRestClientBuilder;
import com.azure.search.documents.implementation.SerializationUtil;
import com.azure.search.documents.indexes.models.IndexDocumentsBatch;
import com.azure.search.documents.models.AutocompleteOptions;
import com.azure.search.documents.models.IndexAction;
import com.azure.search.documents.models.IndexActionType;
import com.azure.search.documents.models.IndexBatchException;
import com.azure.search.documents.indexes.models.IndexDocumentsBatch;
import com.azure.search.documents.models.IndexDocumentsResult;
import com.azure.search.documents.models.RequestOptions;
import com.azure.search.documents.models.ScoringParameter;
Expand Down Expand Up @@ -151,6 +153,7 @@ HttpPipeline getHttpPipeline() {
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents">Add, update, or
* delete documents</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<IndexDocumentsResult> uploadDocuments(Iterable<?> documents) {
return uploadDocumentsWithResponse(documents).map(Response::getValue);
}
Expand All @@ -168,6 +171,7 @@ public Mono<IndexDocumentsResult> uploadDocuments(Iterable<?> documents) {
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents">Add, update, or
* delete documents</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<Response<IndexDocumentsResult>> uploadDocumentsWithResponse(Iterable<?> documents) {
return withContext(context -> uploadDocumentsWithResponse(documents, context));
}
Expand Down Expand Up @@ -196,6 +200,7 @@ Mono<Response<IndexDocumentsResult>> uploadDocumentsWithResponse(Iterable<?> doc
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents">Add, update, or
* delete documents</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<IndexDocumentsResult> mergeDocuments(Iterable<?> documents) {
return mergeDocumentsWithResponse(documents).map(Response::getValue);
}
Expand All @@ -220,6 +225,7 @@ public Mono<IndexDocumentsResult> mergeDocuments(Iterable<?> documents) {
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents">Add, update, or
* delete documents</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<Response<IndexDocumentsResult>> mergeDocumentsWithResponse(Iterable<?> documents) {
return withContext(context -> mergeDocumentsWithResponse(documents, context));
}
Expand Down Expand Up @@ -249,6 +255,7 @@ Mono<Response<IndexDocumentsResult>> mergeDocumentsWithResponse(Iterable<?> docu
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents">Add, update, or
* delete documents</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<IndexDocumentsResult> mergeOrUploadDocuments(Iterable<?> documents) {
return mergeOrUploadDocumentsWithResponse(documents).map(Response::getValue);
}
Expand All @@ -274,6 +281,7 @@ public Mono<IndexDocumentsResult> mergeOrUploadDocuments(Iterable<?> documents)
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents">Add, update, or
* delete documents</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<Response<IndexDocumentsResult>> mergeOrUploadDocumentsWithResponse(Iterable<?> documents) {
return withContext(context -> mergeOrUploadDocumentsWithResponse(documents, context));
}
Expand All @@ -295,6 +303,7 @@ Mono<Response<IndexDocumentsResult>> mergeOrUploadDocumentsWithResponse(Iterable
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents">Add, update, or
* delete documents</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<IndexDocumentsResult> deleteDocuments(Iterable<?> documents) {
return deleteDocumentsWithResponse(documents).map(Response::getValue);
}
Expand All @@ -312,6 +321,7 @@ public Mono<IndexDocumentsResult> deleteDocuments(Iterable<?> documents) {
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents">Add, update, or
* delete documents</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<Response<IndexDocumentsResult>> deleteDocumentsWithResponse(Iterable<?> documents) {
return withContext(context -> deleteDocumentsWithResponse(documents, context));
}
Expand All @@ -320,15 +330,6 @@ Mono<Response<IndexDocumentsResult>> deleteDocumentsWithResponse(Iterable<?> doc
return indexDocumentsWithResponse(buildIndexBatch(documents, IndexActionType.DELETE), context);
}

/**
* Gets the version of the Search service the client is using.
*
* @return The version of the Search service the client is using.
*/
public SearchServiceVersion getServiceVersion() {
return this.serviceVersion;
}

/**
* Gets the endpoint for the Azure Cognitive Search service.
*
Expand All @@ -343,6 +344,7 @@ public String getEndpoint() {
*
* @return the number of documents.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<Long> getDocumentCount() {
return this.getDocumentCountWithResponse().map(Response::getValue);
}
Expand All @@ -352,6 +354,7 @@ public Mono<Long> getDocumentCount() {
*
* @return response containing the number of documents.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<Response<Long>> getDocumentCountWithResponse() {
return withContext(this::getDocumentCountWithResponse);
}
Expand Down Expand Up @@ -425,6 +428,7 @@ private Mono<SearchPagedResponse> search(SearchRequest request, RequestOptions r
.onErrorMap(MappingUtils::exceptionMapper)
.map(searchDocumentResponse -> new SearchPagedResponse(searchDocumentResponse, serviceVersion));
}

/**
* Retrieves a document from the Azure Cognitive Search index.
* <p>
Expand All @@ -435,6 +439,7 @@ private Mono<SearchPagedResponse> search(SearchRequest request, RequestOptions r
* @return the document object
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/Lookup-Document">Lookup document</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<SearchDocument> getDocument(String key) {
return getDocumentWithResponse(key, null, null).map(Response::getValue);
}
Expand All @@ -453,6 +458,7 @@ public Mono<SearchDocument> getDocument(String key) {
* @return a response containing the document object
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/Lookup-Document">Lookup document</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<Response<SearchDocument>> getDocumentWithResponse(String key, List<String> selectedFields,
RequestOptions requestOptions) {
return withContext(context -> getDocumentWithResponse(key, selectedFields, requestOptions, context));
Expand Down Expand Up @@ -538,6 +544,7 @@ private Mono<SuggestPagedResponse> suggest(RequestOptions requestOptions, Sugges
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents">Add, update, or
* delete documents</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<IndexDocumentsResult> indexDocuments(IndexDocumentsBatch<?> batch) {
return indexDocumentsWithResponse(batch).map(Response::getValue);
}
Expand All @@ -555,6 +562,7 @@ public Mono<IndexDocumentsResult> indexDocuments(IndexDocumentsBatch<?> batch) {
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents">Add, update, or
* delete documents</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Mono<Response<IndexDocumentsResult>> indexDocumentsWithResponse(IndexDocumentsBatch<?> batch) {
return withContext(context -> indexDocumentsWithResponse(batch, context));
}
Expand Down Expand Up @@ -635,7 +643,7 @@ private static SearchRequest createSearchRequest(String searchText, SearchOption
.setFilter(searchOptions.getFilter())
.setHighlightPostTag(searchOptions.getHighlightPostTag())
.setHighlightPreTag(searchOptions.getHighlightPreTag())
.setIncludeTotalResultCount(searchOptions.isIncludeTotalResultCount())
.setIncludeTotalResultCount(searchOptions.isTotalCountIncluded())
.setMinimumCoverage(searchOptions.getMinimumCoverage())
.setQueryType(QueryTypeConverter.map(searchOptions.getQueryType()))
.setScoringParameters(scoringParameters)
Expand Down
25 changes: 16 additions & 9 deletions sdk/search/azure-search-documents/src/main/java/com/azure/search/documents/SearchClient.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,9 @@

package com.azure.search.documents;

import com.azure.core.annotation.ReturnType;
import com.azure.core.annotation.ServiceClient;
import com.azure.core.annotation.ServiceMethod;
import com.azure.core.http.HttpPipeline;
import com.azure.core.http.rest.Response;
import com.azure.core.util.Context;
Expand Down Expand Up @@ -72,6 +74,7 @@ HttpPipeline getHttpPipeline() {
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents">Add, update, or
* delete documents</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public IndexDocumentsResult uploadDocuments(Iterable<?> documents) {
return uploadDocumentsWithResponse(documents, Context.NONE).getValue();
}
Expand All @@ -90,6 +93,7 @@ public IndexDocumentsResult uploadDocuments(Iterable<?> documents) {
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents">Add, update, or
* delete documents</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Response<IndexDocumentsResult> uploadDocumentsWithResponse(Iterable<?> documents, Context context) {
return asyncClient.uploadDocumentsWithResponse(documents, context).block();
}
Expand All @@ -114,6 +118,7 @@ public Response<IndexDocumentsResult> uploadDocumentsWithResponse(Iterable<?> do
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents">Add, update, or
* delete documents</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public IndexDocumentsResult mergeDocuments(Iterable<?> documents) {
return mergeDocumentsWithResponse(documents, Context.NONE).getValue();
}
Expand All @@ -139,6 +144,7 @@ public IndexDocumentsResult mergeDocuments(Iterable<?> documents) {
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents">Add, update, or
* delete documents</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Response<IndexDocumentsResult> mergeDocumentsWithResponse(Iterable<?> documents, Context context) {
return asyncClient.mergeDocumentsWithResponse(documents, context).block();
}
Expand All @@ -164,6 +170,7 @@ public Response<IndexDocumentsResult> mergeDocumentsWithResponse(Iterable<?> doc
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents">Add, update, or
* delete documents</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public IndexDocumentsResult mergeOrUploadDocuments(Iterable<?> documents) {
return mergeOrUploadDocumentsWithResponse(documents, Context.NONE).getValue();
}
Expand All @@ -190,6 +197,7 @@ public IndexDocumentsResult mergeOrUploadDocuments(Iterable<?> documents) {
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents">Add, update, or
* delete documents</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Response<IndexDocumentsResult> mergeOrUploadDocumentsWithResponse(Iterable<?> documents, Context context) {
return asyncClient.mergeOrUploadDocumentsWithResponse(documents, context).block();
}
Expand All @@ -207,6 +215,7 @@ public Response<IndexDocumentsResult> mergeOrUploadDocumentsWithResponse(Iterabl
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents">Add, update, or
* delete documents</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public IndexDocumentsResult deleteDocuments(Iterable<?> documents) {
return deleteDocumentsWithResponse(documents, Context.NONE).getValue();
}
Expand All @@ -225,19 +234,11 @@ public IndexDocumentsResult deleteDocuments(Iterable<?> documents) {
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents">Add, update, or
* delete documents</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Response<IndexDocumentsResult> deleteDocumentsWithResponse(Iterable<?> documents, Context context) {
return asyncClient.deleteDocumentsWithResponse(documents, context).block();
}

/**
Copy link
Member

@srnagar srnagar Jun 1, 2020

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The sync client APIs are missing @ServiceMethod annotation and codesnippets too.

* Gets the version of the Search service the client is using.
*
* @return The version of the Search service the client is using.
*/
public SearchServiceVersion getServiceVersion() {
return asyncClient.getServiceVersion();
}

/**
* Gets the endpoint for the Azure Cognitive Search service.
*
Expand All @@ -252,6 +253,7 @@ public String getEndpoint() {
*
* @return the number of documents.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public long getDocumentCount() {
return getDocumentCountWithResponse(Context.NONE).getValue();
}
Expand All @@ -262,6 +264,7 @@ public long getDocumentCount() {
* @param context additional context that is passed through the Http pipeline during the service call
* @return response containing the number of documents.
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Response<Long> getDocumentCountWithResponse(Context context) {
return asyncClient.getDocumentCountWithResponse(context).block();
}
Expand Down Expand Up @@ -315,6 +318,7 @@ public SearchPagedIterable search(String searchText, SearchOptions searchOptions
* @return document object
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/Lookup-Document">Lookup document</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public SearchDocument getDocument(String key) {
return getDocumentWithResponse(key, null, null, Context.NONE).getValue();
}
Expand All @@ -334,6 +338,7 @@ public SearchDocument getDocument(String key) {
* @return response containing a document object
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/Lookup-Document">Lookup document</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Response<SearchDocument> getDocumentWithResponse(String key, List<String> selectedFields,
RequestOptions requestOptions, Context context) {
return asyncClient.getDocumentWithResponse(key, selectedFields, requestOptions, context).block();
Expand Down Expand Up @@ -386,6 +391,7 @@ public SuggestPagedIterable suggest(String searchText, String suggesterName, Sug
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents">Add, update, or
* delete documents</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public IndexDocumentsResult indexDocuments(IndexDocumentsBatch<?> batch) {
return indexDocumentsWithResponse(batch, Context.NONE).getValue();
}
Expand All @@ -404,6 +410,7 @@ public IndexDocumentsResult indexDocuments(IndexDocumentsBatch<?> batch) {
* @see <a href="https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents">Add, update, or
* delete documents</a>
*/
@ServiceMethod(returns = ReturnType.SINGLE)
public Response<IndexDocumentsResult> indexDocumentsWithResponse(IndexDocumentsBatch<?> batch, Context context) {
return asyncClient.indexDocumentsWithResponse(batch, context).block();
}
Expand Down
Loading