Send feedback
Class Document (2.47.0)
Stay organized with collections
Save and categorize content based on your preferences.
Version 2.47.0 keyboard_arrow_down
public final class Document extends GeneratedMessageV3 implements DocumentOrBuilder
Represents the input to API methods.
Protobuf type google.cloud.language.v1.Document
Inherited Members
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT)
com.google.protobuf.GeneratedMessageV3.<ListT>makeMutableCopy(ListT,int)
com.google.protobuf.GeneratedMessageV3.<T>emptyList(java.lang.Class<T>)
com.google.protobuf.GeneratedMessageV3.internalGetMapFieldReflection(int)
Static Fields
CONTENT_FIELD_NUMBER
public static final int CONTENT_FIELD_NUMBER
Field Value
Type Description
int
GCS_CONTENT_URI_FIELD_NUMBER
public static final int GCS_CONTENT_URI_FIELD_NUMBER
Field Value
Type Description
int
LANGUAGE_FIELD_NUMBER
public static final int LANGUAGE_FIELD_NUMBER
Field Value
Type Description
int
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
Field Value
Type Description
int
Static Methods
getDefaultInstance()
public static Document getDefaultInstance ()
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
newBuilder()
public static Document . Builder newBuilder ()
newBuilder(Document prototype)
public static Document . Builder newBuilder ( Document prototype )
Parameter
Name Description
prototypeDocument
public static Document parseDelimitedFrom ( InputStream input )
public static Document parseDelimitedFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(byte[] data)
public static Document parseFrom ( byte [] data )
Parameter
Name Description
databyte []
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom ( byte [] data , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteString data)
public static Document parseFrom ( ByteString data )
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom ( ByteString data , ExtensionRegistryLite extensionRegistry )
public static Document parseFrom ( CodedInputStream input )
public static Document parseFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
public static Document parseFrom ( InputStream input )
public static Document parseFrom ( InputStream input , ExtensionRegistryLite extensionRegistry )
parseFrom(ByteBuffer data)
public static Document parseFrom ( ByteBuffer data )
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom ( ByteBuffer data , ExtensionRegistryLite extensionRegistry )
parser()
public static Parser<Document> parser ()
Methods
equals(Object obj)
public boolean equals ( Object obj )
Parameter
Name Description
objObject
Overrides
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;
Returns
Type Description
String 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;
Returns
Type Description
ByteString The bytes for content.
getDefaultInstanceForType()
public Document getDefaultInstanceForType ()
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;
Returns
Type Description
String 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;
Returns
Type Description
ByteString 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 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;
Returns
Type Description
String 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 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;
Returns
Type Description
ByteString The bytes for language.
getParserForType()
public Parser<Document> getParserForType ()
Overrides
getSerializedSize()
public int getSerializedSize ()
Returns
Type Description
int
Overrides
getSourceCase()
public Document . SourceCase getSourceCase ()
getType()
public Document . Type getType ()
Required. If the type is not set or is TYPE_UNSPECIFIED,
returns an INVALID_ARGUMENT error.
.google.cloud.language.v1.Document.Type type = 1;
getTypeValue()
public int getTypeValue ()
Required. If the type is not set or is TYPE_UNSPECIFIED,
returns an INVALID_ARGUMENT error.
.google.cloud.language.v1.Document.Type type = 1;
Returns
Type Description
int The enum numeric value on the wire for 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;
Returns
Type Description
boolean Whether the content field is set.
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;
Returns
Type Description
boolean Whether the gcsContentUri field is set.
hashCode()
Returns
Type Description
int
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
newBuilderForType()
public Document . Builder newBuilderForType ()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Document . Builder newBuilderForType ( GeneratedMessageV3 . BuilderParent parent )
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance ( GeneratedMessageV3 . UnusedPrivateParameter unused )
Returns
Type Description
Object
Overrides
toBuilder()
public Document . Builder toBuilder ()
writeTo(CodedOutputStream output)
public void writeTo ( CodedOutputStream output )
Overrides
Send feedback
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-01-27 UTC.
Need to tell us more?
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Hard to understand","hardToUnderstand","thumb-down"],["Incorrect information or sample code","incorrectInformationOrSampleCode","thumb-down"],["Missing the information/samples I need","missingTheInformationSamplesINeed","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-01-27 UTC."],[],[]]
