CloudNaturalLanguage.Documents.AnalyzeEntities (Cloud Natural Language API v2-rev20250824-2.0.0)

java.lang.Object
- java.util.AbstractMap<String,Object>
- - com.google.api.client.util.GenericData
  - - com.google.api.client.googleapis.services.AbstractGoogleClientRequest<T>
    - - com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest<T>
      - com.google.api.services.language.v2.CloudNaturalLanguageRequest<AnalyzeEntitiesResponse>
        
        com.google.api.services.language.v2.CloudNaturalLanguage.Documents.AnalyzeEntities

All Implemented Interfaces:: Cloneable, Map<String,Object>

Enclosing class:: CloudNaturalLanguage.Documents

public class CloudNaturalLanguage.Documents.AnalyzeEntities
extends CloudNaturalLanguageRequest<AnalyzeEntitiesResponse>

Nested Class Summary
- Nested classes/interfaces inherited from class com.google.api.client.util.GenericData
  com.google.api.client.util.GenericData.Flags
- Nested classes/interfaces inherited from class java.util.AbstractMap
  AbstractMap.SimpleEntry<K,V>, AbstractMap.SimpleImmutableEntry<K,V>
- Nested classes/interfaces inherited from interface java.util.Map
  Map.Entry<K,V>

Field Summary
- Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
  API_VERSION_HEADER, USER_AGENT_SUFFIX

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`AnalyzeEntities(AnalyzeEntitiesRequest content)` Finds named entities (currently proper names and common nouns) in the text along with entity types, probability, mentions for each entity, and other properties.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CloudNaturalLanguage.Documents.AnalyzeEntities`	`set(String parameterName, Object value)`
`CloudNaturalLanguage.Documents.AnalyzeEntities`	`set$Xgafv(String $Xgafv)` V1 error format.
`CloudNaturalLanguage.Documents.AnalyzeEntities`	`setAccessToken(String accessToken)` OAuth access token.
`CloudNaturalLanguage.Documents.AnalyzeEntities`	`setAlt(String alt)` Data format for response.
`CloudNaturalLanguage.Documents.AnalyzeEntities`	`setCallback(String callback)` JSONP
`CloudNaturalLanguage.Documents.AnalyzeEntities`	`setFields(String fields)` Selector specifying which fields to include in a partial response.
`CloudNaturalLanguage.Documents.AnalyzeEntities`	`setKey(String key)` API key.
`CloudNaturalLanguage.Documents.AnalyzeEntities`	`setOauthToken(String oauthToken)` OAuth 2.0 token for the current user.
`CloudNaturalLanguage.Documents.AnalyzeEntities`	`setPrettyPrint(Boolean prettyPrint)` Returns response with indentations and line breaks.
`CloudNaturalLanguage.Documents.AnalyzeEntities`	`setQuotaUser(String quotaUser)` Available to use for quota purposes for server-side applications.
`CloudNaturalLanguage.Documents.AnalyzeEntities`	`setUploadProtocol(String uploadProtocol)` Upload protocol for media (e.g.
`CloudNaturalLanguage.Documents.AnalyzeEntities`	`setUploadType(String uploadType)` Legacy upload protocol for media (e.g.

Methods inherited from class com.google.api.services.language.v2.CloudNaturalLanguageRequest
get$Xgafv, getAbstractGoogleClient, getAccessToken, getAlt, getCallback, getFields, getKey, getOauthToken, getPrettyPrint, getQuotaUser, getUploadProtocol, getUploadType, setDisableGZipContent, setRequestHeaders

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest
getJsonContent, newExceptionOnError, queue

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest
buildHttpRequest, buildHttpRequestUrl, buildHttpRequestUsingHead, checkRequiredParameter, execute, executeAndDownloadTo, executeAsInputStream, executeMedia, executeMediaAndDownloadTo, executeMediaAsInputStream, executeUnparsed, executeUsingHead, getDisableGZipContent, getHttpContent, getLastResponseHeaders, getLastStatusCode, getLastStatusMessage, getMediaHttpDownloader, getMediaHttpUploader, getRequestHeaders, getRequestMethod, getResponseClass, getReturnRawInputSteam, getUriTemplate, initializeMediaDownload, initializeMediaUpload, queue, setReturnRawInputStream

Methods inherited from class com.google.api.client.util.GenericData
clone, entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys, toString

Methods inherited from class java.util.AbstractMap
clear, containsKey, containsValue, isEmpty, keySet, size, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map
compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

- Constructor Detail
  - AnalyzeEntities
```
protected AnalyzeEntities(AnalyzeEntitiesRequest content)
```
    Finds named entities (currently proper names and common nouns) in the text along with entity types, probability, mentions for each entity, and other properties. Create a request for the method "documents.analyzeEntities". This request holds the parameters needed by the the language server. After setting any optional parameters, call the AbstractGoogleClientRequest.execute() method to invoke the remote operation.
    AnalyzeEntities#initialize(com.google.api.client.googleapis.services.Abst ractGoogleClientRequest) must be called to initialize this instance immediately after invoking the constructor.
    
    Parameters:
    
    content - the AnalyzeEntitiesRequest
    
    Since:
    
    1.13
- Method Detail
  - set$Xgafv
```
public CloudNaturalLanguage.Documents.AnalyzeEntities set$Xgafv(String $Xgafv)
```
    Description copied from class: CloudNaturalLanguageRequest
    
    V1 error format.
    
    Overrides:
    
    set$Xgafv in class CloudNaturalLanguageRequest<AnalyzeEntitiesResponse>
  - setAccessToken
```
public CloudNaturalLanguage.Documents.AnalyzeEntities setAccessToken(String accessToken)
```
    Description copied from class: CloudNaturalLanguageRequest
    
    OAuth access token.
    
    Overrides:
    
    setAccessToken in class CloudNaturalLanguageRequest<AnalyzeEntitiesResponse>
  - setAlt
```
public CloudNaturalLanguage.Documents.AnalyzeEntities setAlt(String alt)
```
    Description copied from class: CloudNaturalLanguageRequest
    
    Data format for response.
    
    Overrides:
    
    setAlt in class CloudNaturalLanguageRequest<AnalyzeEntitiesResponse>
  - setCallback
```
public CloudNaturalLanguage.Documents.AnalyzeEntities setCallback(String callback)
```
    Description copied from class: CloudNaturalLanguageRequest
    
    JSONP
    
    Overrides:
    
    setCallback in class CloudNaturalLanguageRequest<AnalyzeEntitiesResponse>
  - setFields
```
public CloudNaturalLanguage.Documents.AnalyzeEntities setFields(String fields)
```
    Description copied from class: CloudNaturalLanguageRequest
    
    Selector specifying which fields to include in a partial response.
    
    Overrides:
    
    setFields in class CloudNaturalLanguageRequest<AnalyzeEntitiesResponse>
  - setKey
```
public CloudNaturalLanguage.Documents.AnalyzeEntities setKey(String key)
```
    Description copied from class: CloudNaturalLanguageRequest
    
    API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
    
    Overrides:
    
    setKey in class CloudNaturalLanguageRequest<AnalyzeEntitiesResponse>
  - setOauthToken
```
public CloudNaturalLanguage.Documents.AnalyzeEntities setOauthToken(String oauthToken)
```
    Description copied from class: CloudNaturalLanguageRequest
    
    OAuth 2.0 token for the current user.
    
    Overrides:
    
    setOauthToken in class CloudNaturalLanguageRequest<AnalyzeEntitiesResponse>
  - setPrettyPrint
```
public CloudNaturalLanguage.Documents.AnalyzeEntities setPrettyPrint(Boolean prettyPrint)
```
    Description copied from class: CloudNaturalLanguageRequest
    
    Returns response with indentations and line breaks.
    
    Overrides:
    
    setPrettyPrint in class CloudNaturalLanguageRequest<AnalyzeEntitiesResponse>
  - setQuotaUser
```
public CloudNaturalLanguage.Documents.AnalyzeEntities setQuotaUser(String quotaUser)
```
    Description copied from class: CloudNaturalLanguageRequest
    
    Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
    
    Overrides:
    
    setQuotaUser in class CloudNaturalLanguageRequest<AnalyzeEntitiesResponse>
  - setUploadType
```
public CloudNaturalLanguage.Documents.AnalyzeEntities setUploadType(String uploadType)
```
    Description copied from class: CloudNaturalLanguageRequest
    
    Legacy upload protocol for media (e.g. "media", "multipart").
    
    Overrides:
    
    setUploadType in class CloudNaturalLanguageRequest<AnalyzeEntitiesResponse>
  - setUploadProtocol
```
public CloudNaturalLanguage.Documents.AnalyzeEntities setUploadProtocol(String uploadProtocol)
```
    Description copied from class: CloudNaturalLanguageRequest
    
    Upload protocol for media (e.g. "raw", "multipart").
    
    Overrides:
    
    setUploadProtocol in class CloudNaturalLanguageRequest<AnalyzeEntitiesResponse>
  - set
```
public CloudNaturalLanguage.Documents.AnalyzeEntities set(String parameterName,
                                                          Object value)
```
    Overrides:
    
    set in class CloudNaturalLanguageRequest<AnalyzeEntitiesResponse>

Class CloudNaturalLanguage.Documents.AnalyzeEntities

Nested Class Summary

Nested classes/interfaces inherited from class com.google.api.client.util.GenericData

Nested classes/interfaces inherited from class java.util.AbstractMap

Nested classes/interfaces inherited from interface java.util.Map

Field Summary

Fields inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Constructor Summary

Method Summary

Methods inherited from class com.google.api.services.language.v2.CloudNaturalLanguageRequest

Methods inherited from class com.google.api.client.googleapis.services.json.AbstractGoogleJsonClientRequest

Methods inherited from class com.google.api.client.googleapis.services.AbstractGoogleClientRequest

Methods inherited from class com.google.api.client.util.GenericData

Methods inherited from class java.util.AbstractMap

Methods inherited from class java.lang.Object

Methods inherited from interface java.util.Map

Constructor Detail

AnalyzeEntities

Method Detail

set$Xgafv

setAccessToken

setAlt

setCallback

setFields

setKey

setOauthToken

setPrettyPrint

setQuotaUser

setUploadType

setUploadProtocol

set