public final class Document extends GeneratedMessageV3 implements DocumentOrBuilder
Represents the input to API methods.
Protobuf type google.cloud.language.v1beta2.Document
Static Fields
BOILERPLATE_HANDLING_FIELD_NUMBER
public static final int BOILERPLATE_HANDLING_FIELD_NUMBER
Field Value
CONTENT_FIELD_NUMBER
public static final int CONTENT_FIELD_NUMBER
Field Value
GCS_CONTENT_URI_FIELD_NUMBER
public static final int GCS_CONTENT_URI_FIELD_NUMBER
Field Value
LANGUAGE_FIELD_NUMBER
public static final int LANGUAGE_FIELD_NUMBER
Field Value
REFERENCE_WEB_URI_FIELD_NUMBER
public static final int REFERENCE_WEB_URI_FIELD_NUMBER
Field Value
TYPE_FIELD_NUMBER
public static final int TYPE_FIELD_NUMBER
Field Value
Static Methods
getDefaultInstance()
public static Document getDefaultInstance()
Returns
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()
Returns
newBuilder()
public static Document.Builder newBuilder()
Returns
newBuilder(Document prototype)
public static Document.Builder newBuilder(Document prototype)
Parameter
Returns
public static Document parseDelimitedFrom(InputStream input)
Parameter
Returns
Exceptions
public static Document parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(byte[] data)
public static Document parseFrom(byte[] data)
Parameter
Name | Description |
data | byte[]
|
Returns
Exceptions
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteString data)
public static Document parseFrom(ByteString data)
Parameter
Returns
Exceptions
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Document parseFrom(CodedInputStream input)
Parameter
Returns
Exceptions
public static Document parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
public static Document parseFrom(InputStream input)
Parameter
Returns
Exceptions
public static Document parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parseFrom(ByteBuffer data)
public static Document parseFrom(ByteBuffer data)
Parameter
Returns
Exceptions
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static Document parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Returns
Exceptions
parser()
public static Parser<Document> parser()
Returns
Methods
equals(Object obj)
public boolean equals(Object obj)
Parameter
Returns
Overrides
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;
Returns
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;
Returns
Type | Description |
int | The enum numeric value on the wire for boilerplateHandling.
|
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
getDefaultInstanceForType()
public Document getDefaultInstanceForType()
Returns
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
getParserForType()
public Parser<Document> getParserForType()
Returns
Overrides
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;
Returns
Type | Description |
String | 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;
Returns
Type | Description |
ByteString | The bytes for referenceWebUri.
|
getSerializedSize()
public int getSerializedSize()
Returns
Overrides
getSourceCase()
public Document.SourceCase getSourceCase()
Returns
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;
Returns
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;
Returns
Type | Description |
int | The enum numeric value on the wire for type.
|
getUnknownFields()
public final UnknownFieldSet getUnknownFields()
Returns
Overrides
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
Overrides
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Overrides
isInitialized()
public final boolean isInitialized()
Returns
Overrides
newBuilderForType()
public Document.Builder newBuilderForType()
Returns
newBuilderForType(GeneratedMessageV3.BuilderParent parent)
protected Document.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Returns
Overrides
newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Returns
Overrides
toBuilder()
public Document.Builder toBuilder()
Returns
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)
Parameter
Overrides
Exceptions