Package com.google.cloud.language.v1

Class Document

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.cloud.language.v1.Document
All Implemented Interfaces:
DocumentOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Document extends com.google.protobuf.GeneratedMessage implements DocumentOrBuilder
 Represents the input to API methods.
Protobuf type google.cloud.language.v1.Document
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Document.Builder
    Represents the input to API methods.
    static enum 
    Document.SourceCase
     
    static enum 
    Document.Type
    The document types enum.

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

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

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

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    CONTENT_FIELD_NUMBER
     
    static final int
    GCS_CONTENT_URI_FIELD_NUMBER
     
    static final int
    LANGUAGE_FIELD_NUMBER
     
    static final int
    TYPE_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, 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
    Description
    boolean
    equals(Object obj)
     
    String
    getContent()
    The content of the input in string format.
    com.google.protobuf.ByteString
    getContentBytes()
    The content of the input in string format.
    static Document
    getDefaultInstance()
     
    Document
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    String
    getGcsContentUri()
    The Google Cloud Storage URI where the file content is located.
    com.google.protobuf.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).
    com.google.protobuf.ByteString
    getLanguageBytes()
    The language of the document (if not specified, the language is automatically detected).
    com.google.protobuf.Parser<Document>
    getParserForType()
     
    int
    getSerializedSize()
     
    Document.SourceCase
    getSourceCase()
     
    Document.Type
    getType()
    Required.
    int
    getTypeValue()
    Required.
    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 com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Document.Builder
    newBuilder()
     
    static Document.Builder
    newBuilder(Document prototype)
     
    Document.Builder
    newBuilderForType()
     
    protected Document.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Document
    parseDelimitedFrom(InputStream input)
     
    static Document
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Document
    parseFrom(byte[] data)
     
    static Document
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Document
    parseFrom(com.google.protobuf.ByteString data)
     
    static Document
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Document
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Document
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Document
    parseFrom(InputStream input)
     
    static Document
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Document
    parseFrom(ByteBuffer data)
     
    static Document
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Document>
    parser()
     
    Document.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, 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, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    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.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • Field Details

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • 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.v1.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.v1.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.

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • parseDelimitedFrom

      public static Document parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Document parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • 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

    • newBuilder

      public static Document.Builder newBuilder()

    • newBuilder

      public static Document.Builder newBuilder(Document prototype)

    • 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.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • 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.GeneratedMessage

    • getDefaultInstanceForType

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