publicfinalclass DocumentextendsGeneratedMessageV3implementsDocumentOrBuilder
Represents the input to API methods.
Protobuf type google.cloud.language.v1beta2.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
BOILERPLATE_HANDLING_FIELD_NUMBER
publicstaticfinalintBOILERPLATE_HANDLING_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
CONTENT_FIELD_NUMBER
publicstaticfinalintCONTENT_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
GCS_CONTENT_URI_FIELD_NUMBER
publicstaticfinalintGCS_CONTENT_URI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
LANGUAGE_FIELD_NUMBER
publicstaticfinalintLANGUAGE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
REFERENCE_WEB_URI_FIELD_NUMBER
publicstaticfinalintREFERENCE_WEB_URI_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
TYPE_FIELD_NUMBER
publicstaticfinalintTYPE_FIELD_NUMBER
| Field Value |
| Type |
Description |
int |
Static Methods
getDefaultInstance()
publicstaticDocumentgetDefaultInstance()
getDescriptor()
publicstaticfinalDescriptors.DescriptorgetDescriptor()
newBuilder()
publicstaticDocument.BuildernewBuilder()
newBuilder(Document prototype)
publicstaticDocument.BuildernewBuilder(Documentprototype)
| Parameter |
| Name |
Description |
prototype |
Document
|
publicstaticDocumentparseDelimitedFrom(InputStreaminput)
publicstaticDocumentparseDelimitedFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(byte[] data)
publicstaticDocumentparseFrom(byte[]data)
| Parameter |
| Name |
Description |
data |
byte[]
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
publicstaticDocumentparseFrom(byte[]data,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteString data)
publicstaticDocumentparseFrom(ByteStringdata)
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
publicstaticDocumentparseFrom(ByteStringdata,ExtensionRegistryLiteextensionRegistry)
publicstaticDocumentparseFrom(CodedInputStreaminput)
publicstaticDocumentparseFrom(CodedInputStreaminput,ExtensionRegistryLiteextensionRegistry)
publicstaticDocumentparseFrom(InputStreaminput)
publicstaticDocumentparseFrom(InputStreaminput,ExtensionRegistryLiteextensionRegistry)
parseFrom(ByteBuffer data)
publicstaticDocumentparseFrom(ByteBufferdata)
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
publicstaticDocumentparseFrom(ByteBufferdata,ExtensionRegistryLiteextensionRegistry)
parser()
publicstaticParser<Document>parser()
Methods
equals(Object obj)
publicbooleanequals(Objectobj)
| Parameter |
| Name |
Description |
obj |
Object
|
Overrides
getBoilerplateHandling()
publicDocument.BoilerplateHandlinggetBoilerplateHandling()
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;
getBoilerplateHandlingValue()
publicintgetBoilerplateHandlingValue()
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;
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for boilerplateHandling.
|
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()
publicByteStringgetContentBytes()
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()
publicDocumentgetDefaultInstanceForType()
getGcsContentUri()
publicStringgetGcsContentUri()
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()
publicByteStringgetGcsContentUriBytes()
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()
publicStringgetLanguage()
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()
publicByteStringgetLanguageBytes()
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()
publicParser<Document>getParserForType()
Overrides
getReferenceWebUri()
publicStringgetReferenceWebUri()
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;
| Returns |
| Type |
Description |
String |
The referenceWebUri.
|
getReferenceWebUriBytes()
publicByteStringgetReferenceWebUriBytes()
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;
| Returns |
| Type |
Description |
ByteString |
The bytes for referenceWebUri.
|
getSerializedSize()
publicintgetSerializedSize()
| Returns |
| Type |
Description |
int |
Overrides
getSourceCase()
publicDocument.SourceCasegetSourceCase()
getType()
publicDocument.TypegetType()
Required. If the type is not set or is TYPE_UNSPECIFIED,
returns an INVALID_ARGUMENT error.
.google.cloud.language.v1beta2.Document.Type type = 1;
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;
| Returns |
| Type |
Description |
int |
The enum numeric value on the wire for type.
|
hasContent()
publicbooleanhasContent()
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()
publicbooleanhasGcsContentUri()
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()
protectedGeneratedMessageV3.FieldAccessorTableinternalGetFieldAccessorTable()
Overrides
isInitialized()
publicfinalbooleanisInitialized()
Overrides
newBuilderForType()
publicDocument.BuildernewBuilderForType()
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protectedDocument.BuildernewBuilderForType(GeneratedMessageV3.BuilderParentparent)
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protectedObjectnewInstance(GeneratedMessageV3.UnusedPrivateParameterunused)
| Returns |
| Type |
Description |
Object |
Overrides
toBuilder()
publicDocument.BuildertoBuilder()
writeTo(CodedOutputStream output)
publicvoidwriteTo(CodedOutputStreamoutput)
Overrides