Package com.google.cloud.language.v1

Class LanguageServiceClient

  • All Implemented Interfaces:
    com.google.api.gax.core.BackgroundResource, AutoCloseable
    @Generated("by gapic-generator-java")
public class LanguageServiceClient
extends Object
implements com.google.api.gax.core.BackgroundResource
    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: 

    
 // 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().

    The surface of this class includes several types of Java methods for each of the API's methods:

    1. 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.
    2. 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.
    3. 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.

    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: 

    
 // 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: 

    
 // 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: 

    
 // 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.

    • Constructor Detail

      • LanguageServiceClient

        protected LanguageServiceClient​(LanguageServiceSettings settings)
                         throws IOException
        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.
        Throws:
        IOException

    • Method Detail

      • create

        public static final LanguageServiceClient create​(LanguageServiceStub stub)
        Constructs an instance of LanguageServiceClient, using the given stub for making calls. This is for advanced usage - prefer using create(LanguageServiceSettings).

      • analyzeSentiment

        public final AnalyzeSentimentResponse analyzeSentiment​(Document document)
        Analyzes the sentiment of the provided text.

        Sample 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);
 }
        Parameters:
        document - Required. Input document.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • analyzeSentiment

        public final AnalyzeSentimentResponse analyzeSentiment​(Document document,
                                                       EncodingType encodingType)
        Analyzes the sentiment of the provided text.

        Sample 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);
 }
        Parameters:
        document - Required. Input document.
        encodingType - The encoding type used by the API to calculate sentence offsets.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • analyzeSentiment

        public final AnalyzeSentimentResponse analyzeSentiment​(AnalyzeSentimentRequest request)
        Analyzes the sentiment of the provided text.

        Sample 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);
 }
        Parameters:
        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

      • analyzeSentimentCallable

        public final com.google.api.gax.rpc.UnaryCallable<AnalyzeSentimentRequest,​AnalyzeSentimentResponse> analyzeSentimentCallable()
        Analyzes the sentiment of the provided text.

        Sample 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<AnalyzeSentimentResponse> future =
       languageServiceClient.analyzeSentimentCallable().futureCall(request);
   // Do something.
   AnalyzeSentimentResponse response = future.get();
 }

      • analyzeEntities

        public final AnalyzeEntitiesResponse analyzeEntities​(Document document)
        Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.

        Sample 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);
 }
        Parameters:
        document - Required. Input document.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • analyzeEntities

        public final AnalyzeEntitiesResponse analyzeEntities​(Document document,
                                                     EncodingType encodingType)
        Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.

        Sample 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);
 }
        Parameters:
        document - Required. Input document.
        encodingType - The encoding type used by the API to calculate offsets.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • analyzeEntities

        public final AnalyzeEntitiesResponse analyzeEntities​(AnalyzeEntitiesRequest request)
        Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.

        Sample 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);
 }
        Parameters:
        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

      • analyzeEntitiesCallable

        public final com.google.api.gax.rpc.UnaryCallable<AnalyzeEntitiesRequest,​AnalyzeEntitiesResponse> analyzeEntitiesCallable()
        Finds named entities (currently proper names and common nouns) in the text along with entity types, salience, mentions for each entity, and other properties.

        Sample 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<AnalyzeEntitiesResponse> future =
       languageServiceClient.analyzeEntitiesCallable().futureCall(request);
   // Do something.
   AnalyzeEntitiesResponse response = future.get();
 }

      • analyzeEntitySentiment

        public final AnalyzeEntitySentimentResponse analyzeEntitySentiment​(Document document)
        Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities] in the text and analyzes sentiment associated with each entity and its mentions.

        Sample 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();
   AnalyzeEntitySentimentResponse response =
       languageServiceClient.analyzeEntitySentiment(document);
 }
        Parameters:
        document - Required. Input document.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • analyzeEntitySentiment

        public final AnalyzeEntitySentimentResponse analyzeEntitySentiment​(Document document,
                                                                   EncodingType encodingType)
        Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities] in the text and analyzes sentiment associated with each entity and its mentions.

        Sample 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);
   AnalyzeEntitySentimentResponse response =
       languageServiceClient.analyzeEntitySentiment(document, encodingType);
 }
        Parameters:
        document - Required. Input document.
        encodingType - The encoding type used by the API to calculate offsets.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • analyzeEntitySentiment

        public final AnalyzeEntitySentimentResponse analyzeEntitySentiment​(AnalyzeEntitySentimentRequest request)
        Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities] in the text and analyzes sentiment associated with each entity and its mentions.

        Sample 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()) {
   AnalyzeEntitySentimentRequest request =
       AnalyzeEntitySentimentRequest.newBuilder()
           .setDocument(Document.newBuilder().build())
           .setEncodingType(EncodingType.forNumber(0))
           .build();
   AnalyzeEntitySentimentResponse response =
       languageServiceClient.analyzeEntitySentiment(request);
 }
        Parameters:
        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

      • analyzeEntitySentimentCallable

        public final com.google.api.gax.rpc.UnaryCallable<AnalyzeEntitySentimentRequest,​AnalyzeEntitySentimentResponse> analyzeEntitySentimentCallable()
        Finds entities, similar to [AnalyzeEntities][google.cloud.language.v1.LanguageService.AnalyzeEntities] in the text and analyzes sentiment associated with each entity and its mentions.

        Sample 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()) {
   AnalyzeEntitySentimentRequest request =
       AnalyzeEntitySentimentRequest.newBuilder()
           .setDocument(Document.newBuilder().build())
           .setEncodingType(EncodingType.forNumber(0))
           .build();
   ApiFuture<AnalyzeEntitySentimentResponse> future =
       languageServiceClient.analyzeEntitySentimentCallable().futureCall(request);
   // Do something.
   AnalyzeEntitySentimentResponse response = future.get();
 }

      • analyzeSyntax

        public final AnalyzeSyntaxResponse analyzeSyntax​(Document document)
        Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.

        Sample 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();
   AnalyzeSyntaxResponse response = languageServiceClient.analyzeSyntax(document);
 }
        Parameters:
        document - Required. Input document.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • analyzeSyntax

        public final AnalyzeSyntaxResponse analyzeSyntax​(Document document,
                                                 EncodingType encodingType)
        Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.

        Sample 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);
   AnalyzeSyntaxResponse response = languageServiceClient.analyzeSyntax(document, encodingType);
 }
        Parameters:
        document - Required. Input document.
        encodingType - The encoding type used by the API to calculate offsets.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • analyzeSyntax

        public final AnalyzeSyntaxResponse analyzeSyntax​(AnalyzeSyntaxRequest request)
        Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.

        Sample 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()) {
   AnalyzeSyntaxRequest request =
       AnalyzeSyntaxRequest.newBuilder()
           .setDocument(Document.newBuilder().build())
           .setEncodingType(EncodingType.forNumber(0))
           .build();
   AnalyzeSyntaxResponse response = languageServiceClient.analyzeSyntax(request);
 }
        Parameters:
        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

      • analyzeSyntaxCallable

        public final com.google.api.gax.rpc.UnaryCallable<AnalyzeSyntaxRequest,​AnalyzeSyntaxResponse> analyzeSyntaxCallable()
        Analyzes the syntax of the text and provides sentence boundaries and tokenization along with part of speech tags, dependency trees, and other properties.

        Sample 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()) {
   AnalyzeSyntaxRequest request =
       AnalyzeSyntaxRequest.newBuilder()
           .setDocument(Document.newBuilder().build())
           .setEncodingType(EncodingType.forNumber(0))
           .build();
   ApiFuture<AnalyzeSyntaxResponse> future =
       languageServiceClient.analyzeSyntaxCallable().futureCall(request);
   // Do something.
   AnalyzeSyntaxResponse response = future.get();
 }

      • classifyText

        public final ClassifyTextResponse classifyText​(Document document)
        Classifies a document into categories.

        Sample 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);
 }
        Parameters:
        document - Required. Input document.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • classifyText

        public final ClassifyTextResponse classifyText​(ClassifyTextRequest request)
        Classifies a document into categories.

        Sample 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())
           .setClassificationModelOptions(ClassificationModelOptions.newBuilder().build())
           .build();
   ClassifyTextResponse response = languageServiceClient.classifyText(request);
 }
        Parameters:
        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

      • classifyTextCallable

        public final com.google.api.gax.rpc.UnaryCallable<ClassifyTextRequest,​ClassifyTextResponse> classifyTextCallable()
        Classifies a document into categories.

        Sample 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())
           .setClassificationModelOptions(ClassificationModelOptions.newBuilder().build())
           .build();
   ApiFuture<ClassifyTextResponse> future =
       languageServiceClient.classifyTextCallable().futureCall(request);
   // Do something.
   ClassifyTextResponse response = future.get();
 }

      • moderateText

        public final ModerateTextResponse moderateText​(Document document)
        Moderates a document for harmful and sensitive categories.

        Sample 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);
 }
        Parameters:
        document - Required. Input document.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • moderateText

        public final ModerateTextResponse moderateText​(ModerateTextRequest request)
        Moderates a document for harmful and sensitive categories.

        Sample 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);
 }
        Parameters:
        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

      • moderateTextCallable

        public final com.google.api.gax.rpc.UnaryCallable<ModerateTextRequest,​ModerateTextResponse> moderateTextCallable()
        Moderates a document for harmful and sensitive categories.

        Sample 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<ModerateTextResponse> future =
       languageServiceClient.moderateTextCallable().futureCall(request);
   // Do something.
   ModerateTextResponse response = future.get();
 }

      • annotateText

        public final AnnotateTextResponse annotateText​(Document document,
                                               AnnotateTextRequest.Features features)
        A convenience method that provides all the features that analyzeSentiment, analyzeEntities, and analyzeSyntax provide in one call.

        Sample 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);
 }
        Parameters:
        document - Required. Input document.
        features - Required. The enabled features.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • annotateText

        public final AnnotateTextResponse annotateText​(Document document,
                                               AnnotateTextRequest.Features features,
                                               EncodingType encodingType)
        A convenience method that provides all the features that analyzeSentiment, analyzeEntities, and analyzeSyntax provide in one call.

        Sample 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);
 }
        Parameters:
        document - Required. Input document.
        features - Required. The enabled features.
        encodingType - The encoding type used by the API to calculate offsets.
        Throws:
        com.google.api.gax.rpc.ApiException - if the remote call fails

      • annotateText

        public final AnnotateTextResponse annotateText​(AnnotateTextRequest request)
        A convenience method that provides all the features that analyzeSentiment, analyzeEntities, and analyzeSyntax provide in one call.

        Sample 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);
 }
        Parameters:
        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

      • annotateTextCallable

        public final com.google.api.gax.rpc.UnaryCallable<AnnotateTextRequest,​AnnotateTextResponse> annotateTextCallable()
        A convenience method that provides all the features that analyzeSentiment, analyzeEntities, and analyzeSyntax provide in one call.

        Sample 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<AnnotateTextResponse> future =
       languageServiceClient.annotateTextCallable().futureCall(request);
   // Do something.
   AnnotateTextResponse response = future.get();
 }

      • shutdown

        public void shutdown()
        Specified by:
        shutdown in interface com.google.api.gax.core.BackgroundResource

      • isShutdown

        public boolean isShutdown()
        Specified by:
        isShutdown in interface com.google.api.gax.core.BackgroundResource

      • isTerminated

        public boolean isTerminated()
        Specified by:
        isTerminated in interface com.google.api.gax.core.BackgroundResource

      • shutdownNow

        public void shutdownNow()
        Specified by:
        shutdownNow in interface com.google.api.gax.core.BackgroundResource