com.google.cloud.language.v1beta2

Class Document.Builder

java.lang.Object

com.google.protobuf.AbstractMessageLite.Builder

com.google.protobuf.AbstractMessage.Builder<BuilderType>

com.google.protobuf.GeneratedMessageV3.Builder<Document.Builder>

com.google.cloud.language.v1beta2.Document.Builder

All Implemented Interfaces:

DocumentOrBuilder, Message.Builder, MessageLite.Builder, MessageLiteOrBuilder, MessageOrBuilder, Cloneable

Enclosing class:

Document

public static final class Document.Builder
extends GeneratedMessageV3.Builder<Document.Builder>
implements DocumentOrBuilder

 Represents the input to API methods.
 

Protobuf type google.cloud.language.v1beta2.Document

Method Summary

Modifier and Type	Method and Description
Document.Builder	addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Document	build()
Document	buildPartial()
Document.Builder	clear()
Document.Builder	clearBoilerplateHandling() Indicates how detected boilerplate(e.g.
Document.Builder	clearContent() The content of the input in string format.
Document.Builder	clearField(Descriptors.FieldDescriptor field)
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	clearOneof(Descriptors.OneofDescriptor oneof)
Document.Builder	clearReferenceWebUri() The web URI where the document comes from.
Document.Builder	clearSource()
Document.Builder	clearType() Required.
Document.Builder	clone()
Document.BoilerplateHandling	getBoilerplateHandling() Indicates how detected boilerplate(e.g.
int	getBoilerplateHandlingValue() Indicates how detected boilerplate(e.g.
String	getContent() The content of the input in string format.
ByteString	getContentBytes() The content of the input in string format.
Document	getDefaultInstanceForType()
static Descriptors.Descriptor	getDescriptor()
Descriptors.Descriptor	getDescriptorForType()
String	getGcsContentUri() The Google Cloud Storage URI where the file content is located.
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).
ByteString	getLanguageBytes() The language of the document (if not specified, the language is automatically detected).
String	getReferenceWebUri() The web URI where the document comes from.
ByteString	getReferenceWebUriBytes() The web URI where the document comes from.
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 GeneratedMessageV3.FieldAccessorTable	internalGetFieldAccessorTable()
boolean	isInitialized()
Document.Builder	mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Document.Builder	mergeFrom(Document other)
Document.Builder	mergeFrom(Message other)
Document.Builder	mergeUnknownFields(UnknownFieldSet unknownFields)
Document.Builder	setBoilerplateHandling(Document.BoilerplateHandling value) Indicates how detected boilerplate(e.g.
Document.Builder	setBoilerplateHandlingValue(int value) Indicates how detected boilerplate(e.g.
Document.Builder	setContent(String value) The content of the input in string format.
Document.Builder	setContentBytes(ByteString value) The content of the input in string format.
Document.Builder	setField(Descriptors.FieldDescriptor field, Object value)
Document.Builder	setGcsContentUri(String value) The Google Cloud Storage URI where the file content is located.
Document.Builder	setGcsContentUriBytes(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(ByteString value) The language of the document (if not specified, the language is automatically detected).
Document.Builder	setReferenceWebUri(String value) The web URI where the document comes from.
Document.Builder	setReferenceWebUriBytes(ByteString value) The web URI where the document comes from.
Document.Builder	setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Document.Builder	setType(Document.Type value) Required.
Document.Builder	setTypeValue(int value) Required.
Document.Builder	setUnknownFields(UnknownFieldSet unknownFields)

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

getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, 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.MessageOrBuilder

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

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

mergeDelimitedFrom, mergeDelimitedFrom

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

mergeFrom

Method Detail

getDescriptor

public static final Descriptors.Descriptor getDescriptor()

internalGetFieldAccessorTable

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Specified by:

internalGetFieldAccessorTable in class GeneratedMessageV3.Builder<Document.Builder>

clear

public Document.Builder clear()

Specified by:

clear in interface Message.Builder

Specified by:

clear in interface MessageLite.Builder

Overrides:

clear in class GeneratedMessageV3.Builder<Document.Builder>

getDescriptorForType

public Descriptors.Descriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface Message.Builder

Specified by:

getDescriptorForType in interface MessageOrBuilder

Overrides:

getDescriptorForType in class GeneratedMessageV3.Builder<Document.Builder>

getDefaultInstanceForType

public Document getDefaultInstanceForType()

Specified by:

getDefaultInstanceForType in interface MessageLiteOrBuilder

Specified by:

getDefaultInstanceForType in interface MessageOrBuilder

build

public Document build()

Specified by:

build in interface Message.Builder

Specified by:

build in interface MessageLite.Builder

buildPartial

public Document buildPartial()

Specified by:

buildPartial in interface Message.Builder

Specified by:

buildPartial in interface MessageLite.Builder

clone

public Document.Builder clone()

Specified by:

clone in interface Message.Builder

Specified by:

clone in interface MessageLite.Builder

Overrides:

clone in class GeneratedMessageV3.Builder<Document.Builder>

setField

public Document.Builder setField(Descriptors.FieldDescriptor field,
                                 Object value)

Specified by:

setField in interface Message.Builder

Overrides:

setField in class GeneratedMessageV3.Builder<Document.Builder>

clearField

public Document.Builder clearField(Descriptors.FieldDescriptor field)

Specified by:

clearField in interface Message.Builder

Overrides:

clearField in class GeneratedMessageV3.Builder<Document.Builder>

clearOneof

public Document.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Specified by:

clearOneof in interface Message.Builder

Overrides:

clearOneof in class GeneratedMessageV3.Builder<Document.Builder>

setRepeatedField

public Document.Builder setRepeatedField(Descriptors.FieldDescriptor field,
                                         int index,
                                         Object value)

Specified by:

setRepeatedField in interface Message.Builder

Overrides:

setRepeatedField in class GeneratedMessageV3.Builder<Document.Builder>

addRepeatedField

public Document.Builder addRepeatedField(Descriptors.FieldDescriptor field,
                                         Object value)

Specified by:

addRepeatedField in interface Message.Builder

Overrides:

addRepeatedField in class GeneratedMessageV3.Builder<Document.Builder>

mergeFrom

public Document.Builder mergeFrom(Message other)

Specified by:

mergeFrom in interface Message.Builder

Overrides:

mergeFrom in class AbstractMessage.Builder<Document.Builder>

mergeFrom

public Document.Builder mergeFrom(Document other)

isInitialized

public final boolean isInitialized()

Specified by:

isInitialized in interface MessageLiteOrBuilder

Overrides:

isInitialized in class GeneratedMessageV3.Builder<Document.Builder>

mergeFrom

public Document.Builder mergeFrom(CodedInputStream input,
                                  ExtensionRegistryLite extensionRegistry)
                           throws IOException

Specified by:

mergeFrom in interface Message.Builder

Specified by:

mergeFrom in interface MessageLite.Builder

Overrides:

mergeFrom in class 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.v1beta2.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.v1beta2.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.v1beta2.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.v1beta2.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.v1beta2.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 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(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 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(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 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(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.

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

setReferenceWebUri

public Document.Builder setReferenceWebUri(String value)

 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;

Parameters:

value - The referenceWebUri to set.

Returns:

This builder for chaining.

clearReferenceWebUri

public Document.Builder clearReferenceWebUri()

 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:

This builder for chaining.

setReferenceWebUriBytes

public Document.Builder setReferenceWebUriBytes(ByteString value)

 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;

Parameters:

value - The bytes for referenceWebUri to set.

Returns:

This builder for chaining.

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.

setBoilerplateHandlingValue

public Document.Builder setBoilerplateHandlingValue(int value)

 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;

Parameters:

value - The enum numeric value on the wire for boilerplateHandling to set.

Returns:

This builder for chaining.

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.

setBoilerplateHandling

public Document.Builder setBoilerplateHandling(Document.BoilerplateHandling value)

 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;

Parameters:

value - The boilerplateHandling to set.

Returns:

This builder for chaining.

clearBoilerplateHandling

public Document.Builder clearBoilerplateHandling()

 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:

This builder for chaining.

setUnknownFields

public final Document.Builder setUnknownFields(UnknownFieldSet unknownFields)

Specified by:

setUnknownFields in interface Message.Builder

Overrides:

setUnknownFields in class GeneratedMessageV3.Builder<Document.Builder>

mergeUnknownFields

public final Document.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Specified by:

mergeUnknownFields in interface Message.Builder

Overrides:

mergeUnknownFields in class GeneratedMessageV3.Builder<Document.Builder>