com.google.cloud.language.v1beta2

Class Document

java.lang.Object

com.google.protobuf.AbstractMessageLite

com.google.protobuf.AbstractMessage

com.google.protobuf.GeneratedMessageV3

com.google.cloud.language.v1beta2.Document

All Implemented Interfaces:

DocumentOrBuilder, Message, MessageLite, MessageLiteOrBuilder, MessageOrBuilder, Serializable

public final class Document
extends GeneratedMessageV3
implements DocumentOrBuilder

 Represents the input to API methods.
 

Protobuf type google.cloud.language.v1beta2.Document

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Document.BoilerplateHandling Ways of handling boilerplate detected in the document
static class	Document.Builder Represents the input to API methods.
static class	Document.SourceCase
static class	Document.Type The document types enum.

Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

GeneratedMessageV3.BuilderParent, GeneratedMessageV3.ExtendableBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage,BuilderType extends GeneratedMessageV3.ExtendableBuilder<MessageType,BuilderType>>, GeneratedMessageV3.ExtendableMessage<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.ExtendableMessageOrBuilder<MessageType extends GeneratedMessageV3.ExtendableMessage>, GeneratedMessageV3.FieldAccessorTable, GeneratedMessageV3.UnusedPrivateParameter

Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

AbstractMessageLite.InternalOneOfEnum

Field Summary

Fields

Modifier and Type	Field and Description
static int	BOILERPLATE_HANDLING_FIELD_NUMBER
static int	CONTENT_FIELD_NUMBER
static int	GCS_CONTENT_URI_FIELD_NUMBER
static int	LANGUAGE_FIELD_NUMBER
static int	REFERENCE_WEB_URI_FIELD_NUMBER
static int	TYPE_FIELD_NUMBER

Fields inherited from class com.google.protobuf.GeneratedMessageV3

alwaysUseFieldBuilders, unknownFields

Fields inherited from class com.google.protobuf.AbstractMessage

memoizedSize

Fields inherited from class com.google.protobuf.AbstractMessageLite

memoizedHashCode

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
Document.BoilerplateHandling	getBoilerplateHandling() Indicates how detected boilerplate(e.g.
int	getBoilerplateHandlingValue() Indicates how detected boilerplate(e.g.
String	getContent() The content of the input in string format.
ByteString	getContentBytes() The content of the input in string format.
static Document	getDefaultInstance()
Document	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
String	getGcsContentUri() The Google Cloud Storage URI where the file content is located.
ByteString	getGcsContentUriBytes() The Google Cloud Storage URI where the file content is located.
String	getLanguage() The language of the document (if not specified, the language is automatically detected).
ByteString	getLanguageBytes() The language of the document (if not specified, the language is automatically detected).
Parser<Document>	getParserForType()
String	getReferenceWebUri() The web URI where the document comes from.
ByteString	getReferenceWebUriBytes() The web URI where the document comes from.
int	getSerializedSize()
Document.SourceCase	getSourceCase()
Document.Type	getType() Required.
int	getTypeValue() Required.
UnknownFieldSet	getUnknownFields()
boolean	hasContent() The content of the input in string format.
boolean	hasGcsContentUri() The Google Cloud Storage URI where the file content is located.
int	hashCode()
protected GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
static Document.Builder	newBuilder()
static Document.Builder	newBuilder(Document prototype)
Document.Builder	newBuilderForType()
protected Document.Builder	newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Object	newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
static Document	parseDelimitedFrom(InputStream input)
static Document	parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Document	parseFrom(byte[] data)
static Document	parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
static Document	parseFrom(ByteBuffer data)
static Document	parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
static Document	parseFrom(ByteString data)
static Document	parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
static Document	parseFrom(CodedInputStream input)
static Document	parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
static Document	parseFrom(InputStream input)
static Document	parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
static Parser<Document>	parser()
Document.Builder	toBuilder()
void	writeTo(CodedOutputStream output)

Methods inherited from class com.google.protobuf.GeneratedMessageV3

canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof, internalGetMapField, isStringEmpty, makeExtensionsImmutable, mergeFromAndMakeImmutableInternal, mutableCopy, mutableCopy, mutableCopy, mutableCopy, mutableCopy, newBooleanList, newBuilderForType, newDoubleList, newFloatList, newIntList, newLongList, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

Methods inherited from class com.google.protobuf.AbstractMessage

findInitializationErrors, getInitializationErrorString, hashBoolean, hashEnum, hashEnumList, hashFields, hashLong, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite

addAll, addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder

findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, hasField, hasOneof

Methods inherited from interface com.google.protobuf.MessageLite

toByteArray, toByteString, writeDelimitedTo, writeTo

Field Detail

TYPE_FIELD_NUMBER

public static final int TYPE_FIELD_NUMBER

See Also:

Constant Field Values

CONTENT_FIELD_NUMBER

public static final int CONTENT_FIELD_NUMBER

See Also:

Constant Field Values

GCS_CONTENT_URI_FIELD_NUMBER

public static final int GCS_CONTENT_URI_FIELD_NUMBER

See Also:

Constant Field Values

LANGUAGE_FIELD_NUMBER

public static final int LANGUAGE_FIELD_NUMBER

See Also:

Constant Field Values

REFERENCE_WEB_URI_FIELD_NUMBER

public static final int REFERENCE_WEB_URI_FIELD_NUMBER

See Also:

Constant Field Values

BOILERPLATE_HANDLING_FIELD_NUMBER

public static final int BOILERPLATE_HANDLING_FIELD_NUMBER

See Also:

Constant Field Values

Method Detail

newInstance

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

Overrides:

newInstance in class GeneratedMessageV3

getUnknownFields

public final UnknownFieldSet getUnknownFields()

Specified by:

getUnknownFields in interface MessageOrBuilder

Overrides:

getUnknownFields in class GeneratedMessageV3

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3

getSourceCase

public Document.SourceCase getSourceCase()

Specified by:

getSourceCase in interface DocumentOrBuilder

getTypeValue

public int getTypeValue()

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

.google.cloud.language.v1beta2.Document.Type type = 1;

Specified by:

getTypeValue in interface DocumentOrBuilder

Returns:

The enum numeric value on the wire for type.

getType

public Document.Type getType()

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

.google.cloud.language.v1beta2.Document.Type type = 1;

Specified by:

getType in interface DocumentOrBuilder

Returns:

The type.

hasContent

public boolean hasContent()

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

string content = 2;

Specified by:

hasContent in interface DocumentOrBuilder

Returns:

Whether the content field is set.

getContent

public String getContent()

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

string content = 2;

Specified by:

getContent in interface DocumentOrBuilder

Returns:

The content.

getContentBytes

public ByteString getContentBytes()

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

string content = 2;

Specified by:

getContentBytes in interface DocumentOrBuilder

Returns:

The bytes for content.

hasGcsContentUri

public boolean hasGcsContentUri()

 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.
 

string gcs_content_uri = 3;

Specified by:

hasGcsContentUri in interface DocumentOrBuilder

Returns:

Whether the gcsContentUri field is set.

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.
 

string gcs_content_uri = 3;

Specified by:

getGcsContentUri in interface DocumentOrBuilder

Returns:

The gcsContentUri.

getGcsContentUriBytes

public ByteString getGcsContentUriBytes()

 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.
 

string gcs_content_uri = 3;

Specified by:

getGcsContentUriBytes in interface DocumentOrBuilder

Returns:

The bytes for gcsContentUri.

getLanguage

public String getLanguage()

 The language of the document (if not specified, the language is
 automatically detected). Both ISO and BCP-47 language codes are
 accepted.<br>
 [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.
 

string language = 4;

Specified by:

getLanguage in interface DocumentOrBuilder

Returns:

The language.

getLanguageBytes

public ByteString getLanguageBytes()

 The language of the document (if not specified, the language is
 automatically detected). Both ISO and BCP-47 language codes are
 accepted.<br>
 [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.
 

string language = 4;

Specified by:

getLanguageBytes in interface DocumentOrBuilder

Returns:

The bytes for language.

getReferenceWebUri

public String getReferenceWebUri()

 The web URI where the document comes from. This URI is not used for
 fetching the content, but as a hint for analyzing the document.
 

string reference_web_uri = 5;

Specified by:

getReferenceWebUri in interface DocumentOrBuilder

Returns:

The referenceWebUri.

getReferenceWebUriBytes

public ByteString getReferenceWebUriBytes()

 The web URI where the document comes from. This URI is not used for
 fetching the content, but as a hint for analyzing the document.
 

string reference_web_uri = 5;

Specified by:

getReferenceWebUriBytes in interface DocumentOrBuilder

Returns:

The bytes for referenceWebUri.

getBoilerplateHandlingValue

public int getBoilerplateHandlingValue()

 Indicates how detected boilerplate(e.g. advertisements, copyright
 declarations, banners) should be handled for this document. If not
 specified, boilerplate will be treated the same as content.
 

.google.cloud.language.v1beta2.Document.BoilerplateHandling boilerplate_handling = 6;

Specified by:

getBoilerplateHandlingValue in interface DocumentOrBuilder

Returns:

The enum numeric value on the wire for boilerplateHandling.

getBoilerplateHandling

public Document.BoilerplateHandling getBoilerplateHandling()

 Indicates how detected boilerplate(e.g. advertisements, copyright
 declarations, banners) should be handled for this document. If not
 specified, boilerplate will be treated the same as content.
 

.google.cloud.language.v1beta2.Document.BoilerplateHandling boilerplate_handling = 6;

Specified by:

getBoilerplateHandling in interface DocumentOrBuilder

Returns:

The boilerplateHandling.

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3

writeTo

public void writeTo(CodedOutputStream output)
             throws IOException

Specified by:

writeTo in interface MessageLite

Overrides:

writeTo in class GeneratedMessageV3

Throws:

IOException

getSerializedSize

public int getSerializedSize()

Specified by:

getSerializedSize in interface MessageLite

Overrides:

getSerializedSize in class GeneratedMessageV3

equals

public boolean equals(Object obj)

Specified by:

equals in interface Message

Overrides:

equals in class AbstractMessage

hashCode

public int hashCode()

Specified by:

hashCode in interface Message

Overrides:

hashCode in class AbstractMessage

parseFrom

public static Document parseFrom(ByteBuffer data)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Document parseFrom(ByteBuffer data,
                                 ExtensionRegistryLite extensionRegistry)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Document parseFrom(ByteString data)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Document parseFrom(ByteString data,
                                 ExtensionRegistryLite extensionRegistry)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Document parseFrom(byte[] data)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Document parseFrom(byte[] data,
                                 ExtensionRegistryLite extensionRegistry)
                          throws InvalidProtocolBufferException

Throws:

InvalidProtocolBufferException

parseFrom

public static Document parseFrom(InputStream input)
                          throws IOException

Throws:

IOException

parseFrom

public static Document parseFrom(InputStream input,
                                 ExtensionRegistryLite extensionRegistry)
                          throws IOException

Throws:

IOException

parseDelimitedFrom

public static Document parseDelimitedFrom(InputStream input)
                                   throws IOException

Throws:

IOException

parseDelimitedFrom

public static Document parseDelimitedFrom(InputStream input,
                                          ExtensionRegistryLite extensionRegistry)
                                   throws IOException

Throws:

IOException

parseFrom

public static Document parseFrom(CodedInputStream input)
                          throws IOException

Throws:

IOException

parseFrom

public static Document parseFrom(CodedInputStream input,
                                 ExtensionRegistryLite extensionRegistry)
                          throws IOException

Throws:

IOException

newBuilderForType

public Document.Builder newBuilderForType()

Specified by:

newBuilderForType in interface Message

Specified by:

newBuilderForType in interface MessageLite

newBuilder

public static Document.Builder newBuilder()

newBuilder

public static Document.Builder newBuilder(Document prototype)

toBuilder

public Document.Builder toBuilder()

Specified by:

toBuilder in interface Message

Specified by:

toBuilder in interface MessageLite

newBuilderForType

protected Document.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)

Specified by:

newBuilderForType in class GeneratedMessageV3

getDefaultInstance

public static Document getDefaultInstance()

parser

public static Parser<Document> parser()

getParserForType

public Parser<Document> getParserForType()

Specified by:

getParserForType in interface Message

Specified by:

getParserForType in interface MessageLite

Overrides:

getParserForType in class GeneratedMessageV3

getDefaultInstanceForType

public Document getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder