com.google.api.services.language.v2.model

Class Document

java.lang.Object

java.util.AbstractMap<String,Object>

com.google.api.client.util.GenericData

com.google.api.client.json.GenericJson

com.google.api.services.language.v2.model.Document

All Implemented Interfaces:

Cloneable, Map<String,Object>

public final class Document
extends com.google.api.client.json.GenericJson

Represents the input to API methods.

This is the Java data model class that specifies how to parse/serialize into the JSON that is transmitted over HTTP when working with the Cloud Natural Language API. For a detailed explanation see: https://developers.google.com/api-client-library/java/google-http-java-client/json

Author:

Google, Inc.

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>

Constructor Summary

Constructors

Constructor and Description
Document()

Method Summary

Modifier and Type	Method and Description
Document	clone()
String	getContent() The content of the input in string format.
String	getGcsContentUri() The Google Cloud Storage URI where the file content is located.
String	getLanguageCode() Optional.
String	getType() Required.
Document	set(String fieldName, Object value)
Document	setContent(String content) The content of the input in string format.
Document	setGcsContentUri(String gcsContentUri) The Google Cloud Storage URI where the file content is located.
Document	setLanguageCode(String languageCode) Optional.
Document	setType(String type) Required.

Methods inherited from class com.google.api.client.json.GenericJson

getFactory, setFactory, toPrettyString, toString

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

entrySet, equals, get, getClassInfo, getUnknownKeys, hashCode, put, putAll, remove, setUnknownKeys

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

Document

public Document()

Method Detail

getContent

public String getContent()

The content of the input in string format. Cloud audit logging exempt since it is based on user data.

Returns:

value or null for none

setContent

public Document setContent(String content)

The content of the input in string format. Cloud audit logging exempt since it is based on user data.

Parameters:

content - content or null for none

getGcsContentUri

public String getGcsContentUri()

The Google Cloud Storage URI where the file content is located. This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported.

Returns:

value or null for none

setGcsContentUri

public Document setGcsContentUri(String gcsContentUri)

The Google Cloud Storage URI where the file content is located. This URI must be of the form: gs://bucket_name/object_name. For more details, see https://cloud.google.com/storage/docs/reference-uris. NOTE: Cloud Storage object versioning is not supported.

Parameters:

gcsContentUri - gcsContentUri or null for none

getLanguageCode

public String getLanguageCode()

Optional. The language of the document (if not specified, the language is automatically detected). Both ISO and BCP-47 language codes are accepted. [Language Support](https://cloud.google.com/natural-language/docs/languages) lists currently supported languages for each API method. If the language (either specified by the caller or automatically detected) is not supported by the called API method, an `INVALID_ARGUMENT` error is returned.

Returns:

value or null for none

setLanguageCode

public Document setLanguageCode(String languageCode)

Optional. The language of the document (if not specified, the language is automatically detected). Both ISO and BCP-47 language codes are accepted. [Language Support](https://cloud.google.com/natural-language/docs/languages) lists currently supported languages for each API method. If the language (either specified by the caller or automatically detected) is not supported by the called API method, an `INVALID_ARGUMENT` error is returned.

Parameters:

languageCode - languageCode or null for none

getType

public String getType()

Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an `INVALID_ARGUMENT` error.

Returns:

value or null for none

setType

public Document setType(String type)

Required. If the type is not set or is `TYPE_UNSPECIFIED`, returns an `INVALID_ARGUMENT` error.

Parameters:

type - type or null for none

set

public Document set(String fieldName,
                    Object value)

Overrides:

set in class com.google.api.client.json.GenericJson

clone

public Document clone()

Overrides:

clone in class com.google.api.client.json.GenericJson