Package com.google.cloud.language.v1beta2

Class Document

  • All Implemented Interfaces:
    DocumentOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class Document
extends com.google.protobuf.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 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

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

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

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Detail

      • GCS_CONTENT_URI_FIELD_NUMBER

        public static final int GCS_CONTENT_URI_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​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

        public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • 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 com.google.protobuf.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 com.google.protobuf.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 com.google.protobuf.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 com.google.protobuf.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 com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static Document parseFrom​(ByteBuffer data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Document parseFrom​(ByteBuffer data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Document parseFrom​(com.google.protobuf.ByteString data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Document parseFrom​(com.google.protobuf.ByteString data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Document parseFrom​(byte[] data)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Document parseFrom​(byte[] data,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static Document parseFrom​(com.google.protobuf.CodedInputStream input,
                                 com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                          throws IOException
        Throws:
        IOException

      • newBuilderForType

        public Document.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public Document.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected Document.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstance

        public static Document getDefaultInstance()

      • parser

        public static com.google.protobuf.Parser<Document> parser()

      • getParserForType

        public com.google.protobuf.Parser<Document> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public Document getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder