com.google.cloud.language.v2.LanguageServiceClient Maven / Gradle / Ivy
Show all versions of google-cloud-language Show documentation
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.google.cloud.language.v2;
import com.google.api.gax.core.BackgroundResource;
import com.google.api.gax.rpc.UnaryCallable;
import com.google.cloud.language.v2.stub.LanguageServiceStub;
import com.google.cloud.language.v2.stub.LanguageServiceStubSettings;
import java.io.IOException;
import java.util.concurrent.TimeUnit;
import javax.annotation.Generated;
// AUTO-GENERATED DOCUMENTATION AND CLASS.
/**
* Service Description: Provides text analysis operations such as sentiment analysis and entity
* recognition.
*
* This class provides the ability to make remote calls to the backing service through method
* calls that map to API methods. Sample code to get started:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
* Document document = Document.newBuilder().build();
* AnalyzeSentimentResponse response = languageServiceClient.analyzeSentiment(document);
* }
* }
*
* Note: close() needs to be called on the LanguageServiceClient object to clean up resources
* such as threads. In the example above, try-with-resources is used, which automatically calls
* close().
*
*
* Methods
*
* Method
* Description
* Method Variants
*
*
* AnalyzeSentiment
Analyzes the sentiment of the provided text.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* analyzeSentiment(AnalyzeSentimentRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* analyzeSentiment(Document document)
*
analyzeSentiment(Document document, EncodingType encodingType)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* analyzeSentimentCallable()
*
*
*
*
* AnalyzeEntities
Finds named entities (currently proper names and common nouns) in the text along with entity types, probability, mentions for each entity, and other properties.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* analyzeEntities(AnalyzeEntitiesRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* analyzeEntities(Document document)
*
analyzeEntities(Document document, EncodingType encodingType)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* analyzeEntitiesCallable()
*
*
*
*
* ClassifyText
Classifies a document into categories.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* classifyText(ClassifyTextRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* classifyText(Document document)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* classifyTextCallable()
*
*
*
*
* ModerateText
Moderates a document for harmful and sensitive categories.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* moderateText(ModerateTextRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* moderateText(Document document)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* moderateTextCallable()
*
*
*
*
* AnnotateText
A convenience method that provides all features in one call.
* Request object method variants only take one parameter, a request object, which must be constructed before the call.
*
* annotateText(AnnotateTextRequest request)
*
* "Flattened" method variants have converted the fields of the request object into function parameters to enable multiple ways to call the same method.
*
* annotateText(Document document, AnnotateTextRequest.Features features)
*
annotateText(Document document, AnnotateTextRequest.Features features, EncodingType encodingType)
*
* Callable method variants take no parameters and return an immutable API callable object, which can be used to initiate calls to the service.
*
* annotateTextCallable()
*
*
*
*
*
* See the individual methods for example code.
*
*
Many parameters require resource names to be formatted in a particular way. To assist with
* these names, this class includes a format method for each type of name, and additionally a parse
* method to extract the individual identifiers contained within names that are returned.
*
*
This class can be customized by passing in a custom instance of LanguageServiceSettings to
* create(). For example:
*
*
To customize credentials:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* LanguageServiceSettings languageServiceSettings =
* LanguageServiceSettings.newBuilder()
* .setCredentialsProvider(FixedCredentialsProvider.create(myCredentials))
* .build();
* LanguageServiceClient languageServiceClient =
* LanguageServiceClient.create(languageServiceSettings);
* }
*
* To customize the endpoint:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* LanguageServiceSettings languageServiceSettings =
* LanguageServiceSettings.newBuilder().setEndpoint(myEndpoint).build();
* LanguageServiceClient languageServiceClient =
* LanguageServiceClient.create(languageServiceSettings);
* }
*
* To use REST (HTTP1.1/JSON) transport (instead of gRPC) for sending and receiving requests over
* the wire:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* LanguageServiceSettings languageServiceSettings =
* LanguageServiceSettings.newHttpJsonBuilder().build();
* LanguageServiceClient languageServiceClient =
* LanguageServiceClient.create(languageServiceSettings);
* }
*
* Please refer to the GitHub repository's samples for more quickstart code snippets.
*/
@Generated("by gapic-generator-java")
public class LanguageServiceClient implements BackgroundResource {
private final LanguageServiceSettings settings;
private final LanguageServiceStub stub;
/** Constructs an instance of LanguageServiceClient with default settings. */
public static final LanguageServiceClient create() throws IOException {
return create(LanguageServiceSettings.newBuilder().build());
}
/**
* Constructs an instance of LanguageServiceClient, using the given settings. The channels are
* created based on the settings passed in, or defaults for any settings that are not set.
*/
public static final LanguageServiceClient create(LanguageServiceSettings settings)
throws IOException {
return new LanguageServiceClient(settings);
}
/**
* Constructs an instance of LanguageServiceClient, using the given stub for making calls. This is
* for advanced usage - prefer using create(LanguageServiceSettings).
*/
public static final LanguageServiceClient create(LanguageServiceStub stub) {
return new LanguageServiceClient(stub);
}
/**
* Constructs an instance of LanguageServiceClient, using the given settings. This is protected so
* that it is easy to make a subclass, but otherwise, the static factory methods should be
* preferred.
*/
protected LanguageServiceClient(LanguageServiceSettings settings) throws IOException {
this.settings = settings;
this.stub = ((LanguageServiceStubSettings) settings.getStubSettings()).createStub();
}
protected LanguageServiceClient(LanguageServiceStub stub) {
this.settings = null;
this.stub = stub;
}
public final LanguageServiceSettings getSettings() {
return settings;
}
public LanguageServiceStub getStub() {
return stub;
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Analyzes the sentiment of the provided text.
*
*
Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
* Document document = Document.newBuilder().build();
* AnalyzeSentimentResponse response = languageServiceClient.analyzeSentiment(document);
* }
* }
*
* @param document Required. Input document.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AnalyzeSentimentResponse analyzeSentiment(Document document) {
AnalyzeSentimentRequest request =
AnalyzeSentimentRequest.newBuilder().setDocument(document).build();
return analyzeSentiment(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Analyzes the sentiment of the provided text.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
* Document document = Document.newBuilder().build();
* EncodingType encodingType = EncodingType.forNumber(0);
* AnalyzeSentimentResponse response =
* languageServiceClient.analyzeSentiment(document, encodingType);
* }
* }
*
* @param document Required. Input document.
* @param encodingType The encoding type used by the API to calculate sentence offsets.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AnalyzeSentimentResponse analyzeSentiment(
Document document, EncodingType encodingType) {
AnalyzeSentimentRequest request =
AnalyzeSentimentRequest.newBuilder()
.setDocument(document)
.setEncodingType(encodingType)
.build();
return analyzeSentiment(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Analyzes the sentiment of the provided text.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
* AnalyzeSentimentRequest request =
* AnalyzeSentimentRequest.newBuilder()
* .setDocument(Document.newBuilder().build())
* .setEncodingType(EncodingType.forNumber(0))
* .build();
* AnalyzeSentimentResponse response = languageServiceClient.analyzeSentiment(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AnalyzeSentimentResponse analyzeSentiment(AnalyzeSentimentRequest request) {
return analyzeSentimentCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Analyzes the sentiment of the provided text.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
* AnalyzeSentimentRequest request =
* AnalyzeSentimentRequest.newBuilder()
* .setDocument(Document.newBuilder().build())
* .setEncodingType(EncodingType.forNumber(0))
* .build();
* ApiFuture future =
* languageServiceClient.analyzeSentimentCallable().futureCall(request);
* // Do something.
* AnalyzeSentimentResponse response = future.get();
* }
* }
*/
public final UnaryCallable
analyzeSentimentCallable() {
return stub.analyzeSentimentCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Finds named entities (currently proper names and common nouns) in the text along with entity
* types, probability, mentions for each entity, and other properties.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
* Document document = Document.newBuilder().build();
* AnalyzeEntitiesResponse response = languageServiceClient.analyzeEntities(document);
* }
* }
*
* @param document Required. Input document.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AnalyzeEntitiesResponse analyzeEntities(Document document) {
AnalyzeEntitiesRequest request =
AnalyzeEntitiesRequest.newBuilder().setDocument(document).build();
return analyzeEntities(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Finds named entities (currently proper names and common nouns) in the text along with entity
* types, probability, mentions for each entity, and other properties.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
* Document document = Document.newBuilder().build();
* EncodingType encodingType = EncodingType.forNumber(0);
* AnalyzeEntitiesResponse response =
* languageServiceClient.analyzeEntities(document, encodingType);
* }
* }
*
* @param document Required. Input document.
* @param encodingType The encoding type used by the API to calculate offsets.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AnalyzeEntitiesResponse analyzeEntities(
Document document, EncodingType encodingType) {
AnalyzeEntitiesRequest request =
AnalyzeEntitiesRequest.newBuilder()
.setDocument(document)
.setEncodingType(encodingType)
.build();
return analyzeEntities(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Finds named entities (currently proper names and common nouns) in the text along with entity
* types, probability, mentions for each entity, and other properties.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
* AnalyzeEntitiesRequest request =
* AnalyzeEntitiesRequest.newBuilder()
* .setDocument(Document.newBuilder().build())
* .setEncodingType(EncodingType.forNumber(0))
* .build();
* AnalyzeEntitiesResponse response = languageServiceClient.analyzeEntities(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AnalyzeEntitiesResponse analyzeEntities(AnalyzeEntitiesRequest request) {
return analyzeEntitiesCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Finds named entities (currently proper names and common nouns) in the text along with entity
* types, probability, mentions for each entity, and other properties.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
* AnalyzeEntitiesRequest request =
* AnalyzeEntitiesRequest.newBuilder()
* .setDocument(Document.newBuilder().build())
* .setEncodingType(EncodingType.forNumber(0))
* .build();
* ApiFuture future =
* languageServiceClient.analyzeEntitiesCallable().futureCall(request);
* // Do something.
* AnalyzeEntitiesResponse response = future.get();
* }
* }
*/
public final UnaryCallable
analyzeEntitiesCallable() {
return stub.analyzeEntitiesCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Classifies a document into categories.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
* Document document = Document.newBuilder().build();
* ClassifyTextResponse response = languageServiceClient.classifyText(document);
* }
* }
*
* @param document Required. Input document.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ClassifyTextResponse classifyText(Document document) {
ClassifyTextRequest request = ClassifyTextRequest.newBuilder().setDocument(document).build();
return classifyText(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Classifies a document into categories.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
* ClassifyTextRequest request =
* ClassifyTextRequest.newBuilder().setDocument(Document.newBuilder().build()).build();
* ClassifyTextResponse response = languageServiceClient.classifyText(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ClassifyTextResponse classifyText(ClassifyTextRequest request) {
return classifyTextCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Classifies a document into categories.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
* ClassifyTextRequest request =
* ClassifyTextRequest.newBuilder().setDocument(Document.newBuilder().build()).build();
* ApiFuture future =
* languageServiceClient.classifyTextCallable().futureCall(request);
* // Do something.
* ClassifyTextResponse response = future.get();
* }
* }
*/
public final UnaryCallable classifyTextCallable() {
return stub.classifyTextCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Moderates a document for harmful and sensitive categories.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
* Document document = Document.newBuilder().build();
* ModerateTextResponse response = languageServiceClient.moderateText(document);
* }
* }
*
* @param document Required. Input document.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ModerateTextResponse moderateText(Document document) {
ModerateTextRequest request = ModerateTextRequest.newBuilder().setDocument(document).build();
return moderateText(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Moderates a document for harmful and sensitive categories.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
* ModerateTextRequest request =
* ModerateTextRequest.newBuilder().setDocument(Document.newBuilder().build()).build();
* ModerateTextResponse response = languageServiceClient.moderateText(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final ModerateTextResponse moderateText(ModerateTextRequest request) {
return moderateTextCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* Moderates a document for harmful and sensitive categories.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
* ModerateTextRequest request =
* ModerateTextRequest.newBuilder().setDocument(Document.newBuilder().build()).build();
* ApiFuture future =
* languageServiceClient.moderateTextCallable().futureCall(request);
* // Do something.
* ModerateTextResponse response = future.get();
* }
* }
*/
public final UnaryCallable moderateTextCallable() {
return stub.moderateTextCallable();
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* A convenience method that provides all features in one call.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
* Document document = Document.newBuilder().build();
* AnnotateTextRequest.Features features = AnnotateTextRequest.Features.newBuilder().build();
* AnnotateTextResponse response = languageServiceClient.annotateText(document, features);
* }
* }
*
* @param document Required. Input document.
* @param features Required. The enabled features.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AnnotateTextResponse annotateText(
Document document, AnnotateTextRequest.Features features) {
AnnotateTextRequest request =
AnnotateTextRequest.newBuilder().setDocument(document).setFeatures(features).build();
return annotateText(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* A convenience method that provides all features in one call.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
* Document document = Document.newBuilder().build();
* AnnotateTextRequest.Features features = AnnotateTextRequest.Features.newBuilder().build();
* EncodingType encodingType = EncodingType.forNumber(0);
* AnnotateTextResponse response =
* languageServiceClient.annotateText(document, features, encodingType);
* }
* }
*
* @param document Required. Input document.
* @param features Required. The enabled features.
* @param encodingType The encoding type used by the API to calculate offsets.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AnnotateTextResponse annotateText(
Document document, AnnotateTextRequest.Features features, EncodingType encodingType) {
AnnotateTextRequest request =
AnnotateTextRequest.newBuilder()
.setDocument(document)
.setFeatures(features)
.setEncodingType(encodingType)
.build();
return annotateText(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* A convenience method that provides all features in one call.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
* AnnotateTextRequest request =
* AnnotateTextRequest.newBuilder()
* .setDocument(Document.newBuilder().build())
* .setFeatures(AnnotateTextRequest.Features.newBuilder().build())
* .setEncodingType(EncodingType.forNumber(0))
* .build();
* AnnotateTextResponse response = languageServiceClient.annotateText(request);
* }
* }
*
* @param request The request object containing all of the parameters for the API call.
* @throws com.google.api.gax.rpc.ApiException if the remote call fails
*/
public final AnnotateTextResponse annotateText(AnnotateTextRequest request) {
return annotateTextCallable().call(request);
}
// AUTO-GENERATED DOCUMENTATION AND METHOD.
/**
* A convenience method that provides all features in one call.
*
* Sample code:
*
*
{@code
* // This snippet has been automatically generated and should be regarded as a code template only.
* // It will require modifications to work:
* // - It may require correct/in-range values for request initialization.
* // - It may require specifying regional endpoints when creating the service client as shown in
* // https://cloud.google.com/java/docs/setup#configure_endpoints_for_the_client_library
* try (LanguageServiceClient languageServiceClient = LanguageServiceClient.create()) {
* AnnotateTextRequest request =
* AnnotateTextRequest.newBuilder()
* .setDocument(Document.newBuilder().build())
* .setFeatures(AnnotateTextRequest.Features.newBuilder().build())
* .setEncodingType(EncodingType.forNumber(0))
* .build();
* ApiFuture future =
* languageServiceClient.annotateTextCallable().futureCall(request);
* // Do something.
* AnnotateTextResponse response = future.get();
* }
* }
*/
public final UnaryCallable annotateTextCallable() {
return stub.annotateTextCallable();
}
@Override
public final void close() {
stub.close();
}
@Override
public void shutdown() {
stub.shutdown();
}
@Override
public boolean isShutdown() {
return stub.isShutdown();
}
@Override
public boolean isTerminated() {
return stub.isTerminated();
}
@Override
public void shutdownNow() {
stub.shutdownNow();
}
@Override
public boolean awaitTermination(long duration, TimeUnit unit) throws InterruptedException {
return stub.awaitTermination(duration, unit);
}
}