Package com.google.cloud.language.v1

Class Document.Builder

java.lang.Object
com.google.protobuf.AbstractMessageLite.Builder
com.google.protobuf.AbstractMessage.Builder<BuilderT>
com.google.protobuf.GeneratedMessage.Builder<Document.Builder>
com.google.cloud.language.v1.Document.Builder
All Implemented Interfaces:
DocumentOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable
Enclosing class:
Document
public static final class Document.Builder extends com.google.protobuf.GeneratedMessage.Builder<Document.Builder> implements DocumentOrBuilder
 Represents the input to API methods.
Protobuf type google.cloud.language.v1.Document

  • Method Summary

    Modifier and Type
    Method
    Description
    Document
    build()
     
    Document
    buildPartial()
     
    Document.Builder
    clear()
     
    Document.Builder
    clearContent()
    The content of the input in string format.
    Document.Builder
    clearGcsContentUri()
    The Google Cloud Storage URI where the file content is located.
    Document.Builder
    clearLanguage()
    The language of the document (if not specified, the language is automatically detected).
    Document.Builder
    clearSource()
     
    Document.Builder
    clearType()
    Required.
    String
    getContent()
    The content of the input in string format.
    com.google.protobuf.ByteString
    getContentBytes()
    The content of the input in string format.
    Document
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Descriptors.Descriptor
    getDescriptorForType()
     
    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).
    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.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    Document.Builder
    mergeFrom(Document other)
     
    Document.Builder
    mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    Document.Builder
    mergeFrom(com.google.protobuf.Message other)
     
    Document.Builder
    setContent(String value)
    The content of the input in string format.
    Document.Builder
    setContentBytes(com.google.protobuf.ByteString value)
    The content of the input in string format.
    Document.Builder
    setGcsContentUri(String value)
    The Google Cloud Storage URI where the file content is located.
    Document.Builder
    setGcsContentUriBytes(com.google.protobuf.ByteString value)
    The Google Cloud Storage URI where the file content is located.
    Document.Builder
    setLanguage(String value)
    The language of the document (if not specified, the language is automatically detected).
    Document.Builder
    setLanguageBytes(com.google.protobuf.ByteString value)
    The language of the document (if not specified, the language is automatically detected).
    Document.Builder
    setType(Document.Type value)
    Required.
    Document.Builder
    setTypeValue(int value)
    Required.

    Methods inherited from class com.google.protobuf.GeneratedMessage.Builder

    addRepeatedField, clearField, clearOneof, clone, getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownFields, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setField, setRepeatedField, setUnknownFields, setUnknownFieldSetBuilder, setUnknownFieldsProto3

    Methods inherited from class com.google.protobuf.AbstractMessage.Builder

    findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

    addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

    Methods inherited from class java.lang.Object

    equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.Message.Builder

    mergeDelimitedFrom, mergeDelimitedFrom

    Methods inherited from interface com.google.protobuf.MessageLite.Builder

    mergeFrom

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

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

  • 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.Builder<Document.Builder>

    • clear

      public Document.Builder clear()
      Specified by:
      clear in interface com.google.protobuf.Message.Builder
      Specified by:
      clear in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      clear in class com.google.protobuf.GeneratedMessage.Builder<Document.Builder>

    • getDescriptorForType

      public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
      Specified by:
      getDescriptorForType in interface com.google.protobuf.Message.Builder
      Specified by:
      getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
      Overrides:
      getDescriptorForType in class com.google.protobuf.GeneratedMessage.Builder<Document.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public Document.Builder mergeFrom(com.google.protobuf.Message other)
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Document.Builder>

    • mergeFrom

      public Document.Builder mergeFrom(Document other)

    • isInitialized

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

    • mergeFrom

      public Document.Builder mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Specified by:
      mergeFrom in interface com.google.protobuf.Message.Builder
      Specified by:
      mergeFrom in interface com.google.protobuf.MessageLite.Builder
      Overrides:
      mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Document.Builder>
      Throws:
      IOException

    • getSourceCase

      public Document.SourceCase getSourceCase()
      Specified by:
      getSourceCase in interface DocumentOrBuilder

    • clearSource

      public Document.Builder clearSource()

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

    • setTypeValue

      public Document.Builder setTypeValue(int value)
       Required. If the type is not set or is `TYPE_UNSPECIFIED`,
 returns an `INVALID_ARGUMENT` error.
      .google.cloud.language.v1.Document.Type type = 1;
      Parameters:
      value - The enum numeric value on the wire for type to set.
      Returns:
      This builder for chaining.

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

    • setType

      public Document.Builder setType(Document.Type value)
       Required. If the type is not set or is `TYPE_UNSPECIFIED`,
 returns an `INVALID_ARGUMENT` error.
      .google.cloud.language.v1.Document.Type type = 1;
      Parameters:
      value - The type to set.
      Returns:
      This builder for chaining.

    • clearType

      public Document.Builder clearType()
       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:
      This builder for chaining.

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

    • setContent

      public Document.Builder setContent(String value)
       The content of the input in string format.
 Cloud audit logging exempt since it is based on user data.
      string content = 2;
      Parameters:
      value - The content to set.
      Returns:
      This builder for chaining.

    • clearContent

      public Document.Builder clearContent()
       The content of the input in string format.
 Cloud audit logging exempt since it is based on user data.
      string content = 2;
      Returns:
      This builder for chaining.

    • setContentBytes

      public Document.Builder setContentBytes(com.google.protobuf.ByteString value)
       The content of the input in string format.
 Cloud audit logging exempt since it is based on user data.
      string content = 2;
      Parameters:
      value - The bytes for content to set.
      Returns:
      This builder for chaining.

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

    • setGcsContentUri

      public Document.Builder setGcsContentUri(String value)
       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;
      Parameters:
      value - The gcsContentUri to set.
      Returns:
      This builder for chaining.

    • clearGcsContentUri

      public Document.Builder clearGcsContentUri()
       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:
      This builder for chaining.

    • setGcsContentUriBytes

      public Document.Builder setGcsContentUriBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for gcsContentUri to set.
      Returns:
      This builder for chaining.

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

    • setLanguage

      public Document.Builder setLanguage(String value)
       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;
      Parameters:
      value - The language to set.
      Returns:
      This builder for chaining.

    • clearLanguage

      public Document.Builder clearLanguage()
       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;
      Returns:
      This builder for chaining.

    • setLanguageBytes

      public Document.Builder setLanguageBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for language to set.
      Returns:
      This builder for chaining.