Class Document.Builder (0.4.0)

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

Defines the structure for content warehouse document proto.

Protobuf type google.cloud.contentwarehouse.v1.Document

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Document.Builder

Implements

DocumentOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns

Type	Description
Descriptor

Methods

addAllProperties(Iterable<? extends Property> values)

public Document.Builder addAllProperties(Iterable<? extends Property> values)

List of values that are user supplied metadata.

repeated .google.cloud.contentwarehouse.v1.Property properties = 7;

Parameter

Name	Description
values	`Iterable<? extends com.google.cloud.contentwarehouse.v1.Property>`

Returns

Type	Description
Document.Builder

addProperties(Property value)

public Document.Builder addProperties(Property value)

List of values that are user supplied metadata.

repeated .google.cloud.contentwarehouse.v1.Property properties = 7;

Parameter

Name	Description
value	`Property`

Returns

Type	Description
Document.Builder

addProperties(Property.Builder builderForValue)

public Document.Builder addProperties(Property.Builder builderForValue)

List of values that are user supplied metadata.

repeated .google.cloud.contentwarehouse.v1.Property properties = 7;

Parameter

Name	Description
builderForValue	`Property.Builder`

Returns

Type	Description
Document.Builder

addProperties(int index, Property value)

public Document.Builder addProperties(int index, Property value)

List of values that are user supplied metadata.

repeated .google.cloud.contentwarehouse.v1.Property properties = 7;

Parameters

Name	Description
index	`int`
value	`Property`

Returns

Type	Description
Document.Builder

addProperties(int index, Property.Builder builderForValue)

public Document.Builder addProperties(int index, Property.Builder builderForValue)

List of values that are user supplied metadata.

repeated .google.cloud.contentwarehouse.v1.Property properties = 7;

Parameters

Name	Description
index	`int`
builderForValue	`Property.Builder`

Returns

Type	Description
Document.Builder

addPropertiesBuilder()

public Property.Builder addPropertiesBuilder()

List of values that are user supplied metadata.

repeated .google.cloud.contentwarehouse.v1.Property properties = 7;

Returns

Type	Description
Property.Builder

addPropertiesBuilder(int index)

public Property.Builder addPropertiesBuilder(int index)

List of values that are user supplied metadata.

repeated .google.cloud.contentwarehouse.v1.Property properties = 7;

Parameter

Name	Description
index	`int`

Returns

Type	Description
Property.Builder

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
Document.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Document build()

Returns

Type	Description
Document

buildPartial()

public Document buildPartial()

Returns

Type	Description
Document

clear()

public Document.Builder clear()

Returns

Type	Description
Document.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearAsyncEnabled()

public Document.Builder clearAsyncEnabled()

If true, makes the document visible to asynchronous policies and rules.

bool async_enabled = 12;

Returns

Type	Description
Document.Builder	This builder for chaining.

clearCloudAiDocument()

public Document.Builder clearCloudAiDocument()

Document AI format to save the structured content, including OCR.

.google.cloud.documentai.v1.Document cloud_ai_document = 4;

Returns

Type	Description
Document.Builder

clearCreateTime()

public Document.Builder clearCreateTime()

Output only. The time when the document is created.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Document.Builder

clearCreator()

public Document.Builder clearCreator()

The user who creates the document.

string creator = 13;

Returns

Type	Description
Document.Builder	This builder for chaining.

clearDisplayName()

public Document.Builder clearDisplayName()

Required. Display name of the document given by the user. This name will be displayed in the UI. Customer can populate this field with the name of the document. This differs from the 'title' field as 'title' is optional and stores the top heading in the document.

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
Document.Builder	This builder for chaining.

clearDisplayUri()

public Document.Builder clearDisplayUri()

Uri to display the document, for example, in the UI.

string display_uri = 17;

Returns

Type	Description
Document.Builder	This builder for chaining.

clearDocumentSchemaName()

public Document.Builder clearDocumentSchemaName()

The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.

string document_schema_name = 3 [(.google.api.resource_reference) = { ... }

Returns

Type	Description
Document.Builder	This builder for chaining.

clearField(Descriptors.FieldDescriptor field)

public Document.Builder clearField(Descriptors.FieldDescriptor field)

Parameter

Name	Description
field	`FieldDescriptor`

Returns

Type	Description
Document.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearInlineRawDocument()

public Document.Builder clearInlineRawDocument()

Raw document content.

bytes inline_raw_document = 6;

Returns

Type	Description
Document.Builder	This builder for chaining.

clearName()

public Document.Builder clearName()

The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}. The name is ignored when creating a document.

string name = 1;

Returns

Type	Description
Document.Builder	This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public Document.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter

Name	Description
oneof	`OneofDescriptor`

Returns

Type	Description
Document.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

clearPlainText()

public Document.Builder clearPlainText()

Other document format, such as PPTX, XLXS

string plain_text = 15;

Returns

Type	Description
Document.Builder	This builder for chaining.

clearProperties()

public Document.Builder clearProperties()

List of values that are user supplied metadata.

repeated .google.cloud.contentwarehouse.v1.Property properties = 7;

Returns

Type	Description
Document.Builder

clearRawDocument()

public Document.Builder clearRawDocument()

Returns

Type	Description
Document.Builder

clearRawDocumentFileType()

public Document.Builder clearRawDocumentFileType()

This is used when DocAI was not used to load the document and parsing/ extracting is needed for the inline_raw_document. For example, if inline_raw_document is the byte representation of a PDF file, then this should be set to: RAW_DOCUMENT_FILE_TYPE_PDF.

.google.cloud.contentwarehouse.v1.RawDocumentFileType raw_document_file_type = 10;

Returns

Type	Description
Document.Builder	This builder for chaining.

clearRawDocumentPath()

public Document.Builder clearRawDocumentPath()

Raw document file in Cloud Storage path.

string raw_document_path = 5;

Returns

Type	Description
Document.Builder	This builder for chaining.

clearReferenceId()

public Document.Builder clearReferenceId()

The reference ID set by customers. Must be unique per project and location.

string reference_id = 11;

Returns

Type	Description
Document.Builder	This builder for chaining.

clearStructuredContent()

public Document.Builder clearStructuredContent()

Returns

Type	Description
Document.Builder

clearStructuredContentUri()

public Document.Builder clearStructuredContentUri()

A path linked to structured content file.

string structured_content_uri = 16;

Returns

Type	Description
Document.Builder	This builder for chaining.

clearTextExtractionDisabled()

public Document.Builder clearTextExtractionDisabled()

If true, text extraction will not be performed.

bool text_extraction_disabled = 19;

Returns

Type	Description
Document.Builder	This builder for chaining.

clearTitle()

public Document.Builder clearTitle()

Title that describes the document. This is usually present in the top section of the document, and is a mandatory field for the question-answering feature.

string title = 18;

Returns

Type	Description
Document.Builder	This builder for chaining.

clearUpdateTime()

public Document.Builder clearUpdateTime()

Output only. The time when the document is last updated.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Document.Builder

clearUpdater()

public Document.Builder clearUpdater()

The user who lastly updates the document.

string updater = 14;

Returns

Type	Description
Document.Builder	This builder for chaining.

clone()

public Document.Builder clone()

Returns

Type	Description
Document.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getAsyncEnabled()

public boolean getAsyncEnabled()

If true, makes the document visible to asynchronous policies and rules.

bool async_enabled = 12;

Returns

Type	Description
boolean	The asyncEnabled.

getCloudAiDocument()

public Document getCloudAiDocument()

Document AI format to save the structured content, including OCR.

.google.cloud.documentai.v1.Document cloud_ai_document = 4;

Returns

Type	Description
com.google.cloud.documentai.v1.Document	The cloudAiDocument.

getCloudAiDocumentBuilder()

public Document.Builder getCloudAiDocumentBuilder()

Document AI format to save the structured content, including OCR.

.google.cloud.documentai.v1.Document cloud_ai_document = 4;

Returns

Type	Description
com.google.cloud.documentai.v1.Document.Builder

getCloudAiDocumentOrBuilder()

public DocumentOrBuilder getCloudAiDocumentOrBuilder()

Document AI format to save the structured content, including OCR.

.google.cloud.documentai.v1.Document cloud_ai_document = 4;

Returns

Type	Description
com.google.cloud.documentai.v1.DocumentOrBuilder

getCreateTime()

public Timestamp getCreateTime()

Output only. The time when the document is created.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Timestamp	The createTime.

getCreateTimeBuilder()

public Timestamp.Builder getCreateTimeBuilder()

Output only. The time when the document is created.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Builder

getCreateTimeOrBuilder()

public TimestampOrBuilder getCreateTimeOrBuilder()

Output only. The time when the document is created.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
TimestampOrBuilder

getCreator()

public String getCreator()

The user who creates the document.

string creator = 13;

Returns

Type	Description
String	The creator.

getCreatorBytes()

public ByteString getCreatorBytes()

The user who creates the document.

string creator = 13;

Returns

Type	Description
ByteString	The bytes for creator.

getDefaultInstanceForType()

public Document getDefaultInstanceForType()

Returns

Type	Description
Document

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns

Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

getDisplayName()

public String getDisplayName()

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
String	The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Returns

Type	Description
ByteString	The bytes for displayName.

getDisplayUri()

public String getDisplayUri()

Uri to display the document, for example, in the UI.

string display_uri = 17;

Returns

Type	Description
String	The displayUri.

getDisplayUriBytes()

public ByteString getDisplayUriBytes()

Uri to display the document, for example, in the UI.

string display_uri = 17;

Returns

Type	Description
ByteString	The bytes for displayUri.

getDocumentSchemaName()

public String getDocumentSchemaName()

The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.

string document_schema_name = 3 [(.google.api.resource_reference) = { ... }

Returns

Type	Description
String	The documentSchemaName.

getDocumentSchemaNameBytes()

public ByteString getDocumentSchemaNameBytes()

The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.

string document_schema_name = 3 [(.google.api.resource_reference) = { ... }

Returns

Type	Description
ByteString	The bytes for documentSchemaName.

getInlineRawDocument()

public ByteString getInlineRawDocument()

Raw document content.

bytes inline_raw_document = 6;

Returns

Type	Description
ByteString	The inlineRawDocument.

getName()

public String getName()

The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}. The name is ignored when creating a document.

string name = 1;

Returns

Type	Description
String	The name.

getNameBytes()

public ByteString getNameBytes()

The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}. The name is ignored when creating a document.

string name = 1;

Returns

Type	Description
ByteString	The bytes for name.

getPlainText()

public String getPlainText()

Other document format, such as PPTX, XLXS

string plain_text = 15;

Returns

Type	Description
String	The plainText.

getPlainTextBytes()

public ByteString getPlainTextBytes()

Other document format, such as PPTX, XLXS

string plain_text = 15;

Returns

Type	Description
ByteString	The bytes for plainText.

getProperties(int index)

public Property getProperties(int index)

List of values that are user supplied metadata.

repeated .google.cloud.contentwarehouse.v1.Property properties = 7;

Parameter

Name	Description
index	`int`

Returns

Type	Description
Property

getPropertiesBuilder(int index)

public Property.Builder getPropertiesBuilder(int index)

List of values that are user supplied metadata.

repeated .google.cloud.contentwarehouse.v1.Property properties = 7;

Parameter

Name	Description
index	`int`

Returns

Type	Description
Property.Builder

getPropertiesBuilderList()

public List<Property.Builder> getPropertiesBuilderList()

List of values that are user supplied metadata.

repeated .google.cloud.contentwarehouse.v1.Property properties = 7;

Returns

Type	Description
List<Builder>

getPropertiesCount()

public int getPropertiesCount()

List of values that are user supplied metadata.

repeated .google.cloud.contentwarehouse.v1.Property properties = 7;

Returns

Type	Description
int

getPropertiesList()

public List<Property> getPropertiesList()

List of values that are user supplied metadata.

repeated .google.cloud.contentwarehouse.v1.Property properties = 7;

Returns

Type	Description
List<Property>

getPropertiesOrBuilder(int index)

public PropertyOrBuilder getPropertiesOrBuilder(int index)

List of values that are user supplied metadata.

repeated .google.cloud.contentwarehouse.v1.Property properties = 7;

Parameter

Name	Description
index	`int`

Returns

Type	Description
PropertyOrBuilder

getPropertiesOrBuilderList()

public List<? extends PropertyOrBuilder> getPropertiesOrBuilderList()

List of values that are user supplied metadata.

repeated .google.cloud.contentwarehouse.v1.Property properties = 7;

Returns

Type	Description
List<? extends com.google.cloud.contentwarehouse.v1.PropertyOrBuilder>

getRawDocumentCase()

public Document.RawDocumentCase getRawDocumentCase()

Returns

Type	Description
Document.RawDocumentCase

getRawDocumentFileType()

public RawDocumentFileType getRawDocumentFileType()

.google.cloud.contentwarehouse.v1.RawDocumentFileType raw_document_file_type = 10;

Returns

Type	Description
RawDocumentFileType	The rawDocumentFileType.

getRawDocumentFileTypeValue()

public int getRawDocumentFileTypeValue()

.google.cloud.contentwarehouse.v1.RawDocumentFileType raw_document_file_type = 10;

Returns

Type	Description
int	The enum numeric value on the wire for rawDocumentFileType.

getRawDocumentPath()

public String getRawDocumentPath()

Raw document file in Cloud Storage path.

string raw_document_path = 5;

Returns

Type	Description
String	The rawDocumentPath.

getRawDocumentPathBytes()

public ByteString getRawDocumentPathBytes()

Raw document file in Cloud Storage path.

string raw_document_path = 5;

Returns

Type	Description
ByteString	The bytes for rawDocumentPath.

getReferenceId()

public String getReferenceId()

The reference ID set by customers. Must be unique per project and location.

string reference_id = 11;

Returns

Type	Description
String	The referenceId.

getReferenceIdBytes()

public ByteString getReferenceIdBytes()

The reference ID set by customers. Must be unique per project and location.

string reference_id = 11;

Returns

Type	Description
ByteString	The bytes for referenceId.

getStructuredContentCase()

public Document.StructuredContentCase getStructuredContentCase()

Returns

Type	Description
Document.StructuredContentCase

getStructuredContentUri()

public String getStructuredContentUri()

A path linked to structured content file.

string structured_content_uri = 16;

Returns

Type	Description
String	The structuredContentUri.

getStructuredContentUriBytes()

public ByteString getStructuredContentUriBytes()

A path linked to structured content file.

string structured_content_uri = 16;

Returns

Type	Description
ByteString	The bytes for structuredContentUri.

getTextExtractionDisabled()

public boolean getTextExtractionDisabled()

If true, text extraction will not be performed.

bool text_extraction_disabled = 19;

Returns

Type	Description
boolean	The textExtractionDisabled.

getTitle()

public String getTitle()

Title that describes the document. This is usually present in the top section of the document, and is a mandatory field for the question-answering feature.

string title = 18;

Returns

Type	Description
String	The title.

getTitleBytes()

public ByteString getTitleBytes()

Title that describes the document. This is usually present in the top section of the document, and is a mandatory field for the question-answering feature.

string title = 18;

Returns

Type	Description
ByteString	The bytes for title.

getUpdateTime()

public Timestamp getUpdateTime()

Output only. The time when the document is last updated.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Timestamp	The updateTime.

getUpdateTimeBuilder()

public Timestamp.Builder getUpdateTimeBuilder()

Output only. The time when the document is last updated.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
Builder

getUpdateTimeOrBuilder()

public TimestampOrBuilder getUpdateTimeOrBuilder()

Output only. The time when the document is last updated.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
TimestampOrBuilder

getUpdater()

public String getUpdater()

The user who lastly updates the document.

string updater = 14;

Returns

Type	Description
String	The updater.

getUpdaterBytes()

public ByteString getUpdaterBytes()

The user who lastly updates the document.

string updater = 14;

Returns

Type	Description
ByteString	The bytes for updater.

hasCloudAiDocument()

public boolean hasCloudAiDocument()

Document AI format to save the structured content, including OCR.

.google.cloud.documentai.v1.Document cloud_ai_document = 4;

Returns

Type	Description
boolean	Whether the cloudAiDocument field is set.

hasCreateTime()

public boolean hasCreateTime()

Output only. The time when the document is created.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the createTime field is set.

hasInlineRawDocument()

public boolean hasInlineRawDocument()

Raw document content.

bytes inline_raw_document = 6;

Returns

Type	Description
boolean	Whether the inlineRawDocument field is set.

hasPlainText()

public boolean hasPlainText()

Other document format, such as PPTX, XLXS

string plain_text = 15;

Returns

Type	Description
boolean	Whether the plainText field is set.

hasRawDocumentPath()

public boolean hasRawDocumentPath()

Raw document file in Cloud Storage path.

string raw_document_path = 5;

Returns

Type	Description
boolean	Whether the rawDocumentPath field is set.

hasUpdateTime()

public boolean hasUpdateTime()

Output only. The time when the document is last updated.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Returns

Type	Description
boolean	Whether the updateTime field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()

Returns

Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns

Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeCloudAiDocument(Document value)

public Document.Builder mergeCloudAiDocument(Document value)

Document AI format to save the structured content, including OCR.

.google.cloud.documentai.v1.Document cloud_ai_document = 4;

Parameter

Name	Description
value	`com.google.cloud.documentai.v1.Document`

Returns

Type	Description
Document.Builder

mergeCreateTime(Timestamp value)

public Document.Builder mergeCreateTime(Timestamp value)

Output only. The time when the document is created.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	`Timestamp`

Returns

Type	Description
Document.Builder

mergeFrom(Document other)

public Document.Builder mergeFrom(Document other)

Parameter

Name	Description
other	`Document`

Returns

Type	Description
Document.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

Parameters

Name	Description
input	`CodedInputStream`
extensionRegistry	`ExtensionRegistryLite`

Returns

Type	Description
Document.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions

Type	Description
IOException

mergeFrom(Message other)

public Document.Builder mergeFrom(Message other)

Parameter

Name	Description
other	`Message`

Returns

Type	Description
Document.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Document.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
Document.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

mergeUpdateTime(Timestamp value)

public Document.Builder mergeUpdateTime(Timestamp value)

Output only. The time when the document is last updated.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	`Timestamp`

Returns

Type	Description
Document.Builder

removeProperties(int index)

public Document.Builder removeProperties(int index)

List of values that are user supplied metadata.

repeated .google.cloud.contentwarehouse.v1.Property properties = 7;

Parameter

Name	Description
index	`int`

Returns

Type	Description
Document.Builder

setAsyncEnabled(boolean value)

public Document.Builder setAsyncEnabled(boolean value)

If true, makes the document visible to asynchronous policies and rules.

bool async_enabled = 12;

Parameter

Name	Description
value	`boolean` The asyncEnabled to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setCloudAiDocument(Document value)

public Document.Builder setCloudAiDocument(Document value)

Document AI format to save the structured content, including OCR.

.google.cloud.documentai.v1.Document cloud_ai_document = 4;

Parameter

Name	Description
value	`com.google.cloud.documentai.v1.Document`

Returns

Type	Description
Document.Builder

setCloudAiDocument(Document.Builder builderForValue)

public Document.Builder setCloudAiDocument(Document.Builder builderForValue)

Document AI format to save the structured content, including OCR.

.google.cloud.documentai.v1.Document cloud_ai_document = 4;

Parameter

Name	Description
builderForValue	`com.google.cloud.documentai.v1.Document.Builder`

Returns

Type	Description
Document.Builder

setCreateTime(Timestamp value)

public Document.Builder setCreateTime(Timestamp value)

Output only. The time when the document is created.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	`Timestamp`

Returns

Type	Description
Document.Builder

setCreateTime(Timestamp.Builder builderForValue)

public Document.Builder setCreateTime(Timestamp.Builder builderForValue)

Output only. The time when the document is created.

.google.protobuf.Timestamp create_time = 9 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
builderForValue	`Builder`

Returns

Type	Description
Document.Builder

setCreator(String value)

public Document.Builder setCreator(String value)

The user who creates the document.

string creator = 13;

Parameter

Name	Description
value	`String` The creator to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setCreatorBytes(ByteString value)

public Document.Builder setCreatorBytes(ByteString value)

The user who creates the document.

string creator = 13;

Parameter

Name	Description
value	`ByteString` The bytes for creator to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setDisplayName(String value)

public Document.Builder setDisplayName(String value)

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	`String` The displayName to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setDisplayNameBytes(ByteString value)

public Document.Builder setDisplayNameBytes(ByteString value)

string display_name = 2 [(.google.api.field_behavior) = REQUIRED];

Parameter

Name	Description
value	`ByteString` The bytes for displayName to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setDisplayUri(String value)

public Document.Builder setDisplayUri(String value)

Uri to display the document, for example, in the UI.

string display_uri = 17;

Parameter

Name	Description
value	`String` The displayUri to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setDisplayUriBytes(ByteString value)

public Document.Builder setDisplayUriBytes(ByteString value)

Uri to display the document, for example, in the UI.

string display_uri = 17;

Parameter

Name	Description
value	`ByteString` The bytes for displayUri to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setDocumentSchemaName(String value)

public Document.Builder setDocumentSchemaName(String value)

The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.

string document_schema_name = 3 [(.google.api.resource_reference) = { ... }

Parameter

Name	Description
value	`String` The documentSchemaName to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setDocumentSchemaNameBytes(ByteString value)

public Document.Builder setDocumentSchemaNameBytes(ByteString value)

The Document schema name. Format: projects/{project_number}/locations/{location}/documentSchemas/{document_schema_id}.

string document_schema_name = 3 [(.google.api.resource_reference) = { ... }

Parameter

Name	Description
value	`ByteString` The bytes for documentSchemaName to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setField(Descriptors.FieldDescriptor field, Object value)

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

Parameters

Name	Description
field	`FieldDescriptor`
value	`Object`

Returns

Type	Description
Document.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setInlineRawDocument(ByteString value)

public Document.Builder setInlineRawDocument(ByteString value)

Raw document content.

bytes inline_raw_document = 6;

Parameter

Name	Description
value	`ByteString` The inlineRawDocument to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setName(String value)

public Document.Builder setName(String value)

The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}. The name is ignored when creating a document.

string name = 1;

Parameter

Name	Description
value	`String` The name to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setNameBytes(ByteString value)

public Document.Builder setNameBytes(ByteString value)

The resource name of the document. Format: projects/{project_number}/locations/{location}/documents/{document_id}. The name is ignored when creating a document.

string name = 1;

Parameter

Name	Description
value	`ByteString` The bytes for name to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setPlainText(String value)

public Document.Builder setPlainText(String value)

Other document format, such as PPTX, XLXS

string plain_text = 15;

Parameter

Name	Description
value	`String` The plainText to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setPlainTextBytes(ByteString value)

public Document.Builder setPlainTextBytes(ByteString value)

Other document format, such as PPTX, XLXS

string plain_text = 15;

Parameter

Name	Description
value	`ByteString` The bytes for plainText to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setProperties(int index, Property value)

public Document.Builder setProperties(int index, Property value)

List of values that are user supplied metadata.

repeated .google.cloud.contentwarehouse.v1.Property properties = 7;

Parameters

Name	Description
index	`int`
value	`Property`

Returns

Type	Description
Document.Builder

setProperties(int index, Property.Builder builderForValue)

public Document.Builder setProperties(int index, Property.Builder builderForValue)

List of values that are user supplied metadata.

repeated .google.cloud.contentwarehouse.v1.Property properties = 7;

Parameters

Name	Description
index	`int`
builderForValue	`Property.Builder`

Returns

Type	Description
Document.Builder

setRawDocumentFileType(RawDocumentFileType value)

public Document.Builder setRawDocumentFileType(RawDocumentFileType value)

.google.cloud.contentwarehouse.v1.RawDocumentFileType raw_document_file_type = 10;

Parameter

Name	Description
value	`RawDocumentFileType` The rawDocumentFileType to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setRawDocumentFileTypeValue(int value)

public Document.Builder setRawDocumentFileTypeValue(int value)

.google.cloud.contentwarehouse.v1.RawDocumentFileType raw_document_file_type = 10;

Parameter

Name	Description
value	`int` The enum numeric value on the wire for rawDocumentFileType to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setRawDocumentPath(String value)

public Document.Builder setRawDocumentPath(String value)

Raw document file in Cloud Storage path.

string raw_document_path = 5;

Parameter

Name	Description
value	`String` The rawDocumentPath to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setRawDocumentPathBytes(ByteString value)

public Document.Builder setRawDocumentPathBytes(ByteString value)

Raw document file in Cloud Storage path.

string raw_document_path = 5;

Parameter

Name	Description
value	`ByteString` The bytes for rawDocumentPath to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setReferenceId(String value)

public Document.Builder setReferenceId(String value)

The reference ID set by customers. Must be unique per project and location.

string reference_id = 11;

Parameter

Name	Description
value	`String` The referenceId to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setReferenceIdBytes(ByteString value)

public Document.Builder setReferenceIdBytes(ByteString value)

The reference ID set by customers. Must be unique per project and location.

string reference_id = 11;

Parameter

Name	Description
value	`ByteString` The bytes for referenceId to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

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

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

Parameters

Name	Description
field	`FieldDescriptor`
index	`int`
value	`Object`

Returns

Type	Description
Document.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

setStructuredContentUri(String value)

public Document.Builder setStructuredContentUri(String value)

A path linked to structured content file.

string structured_content_uri = 16;

Parameter

Name	Description
value	`String` The structuredContentUri to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setStructuredContentUriBytes(ByteString value)

public Document.Builder setStructuredContentUriBytes(ByteString value)

A path linked to structured content file.

string structured_content_uri = 16;

Parameter

Name	Description
value	`ByteString` The bytes for structuredContentUri to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setTextExtractionDisabled(boolean value)

public Document.Builder setTextExtractionDisabled(boolean value)

If true, text extraction will not be performed.

bool text_extraction_disabled = 19;

Parameter

Name	Description
value	`boolean` The textExtractionDisabled to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setTitle(String value)

public Document.Builder setTitle(String value)

Title that describes the document. This is usually present in the top section of the document, and is a mandatory field for the question-answering feature.

string title = 18;

Parameter

Name	Description
value	`String` The title to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setTitleBytes(ByteString value)

public Document.Builder setTitleBytes(ByteString value)

Title that describes the document. This is usually present in the top section of the document, and is a mandatory field for the question-answering feature.

string title = 18;

Parameter

Name	Description
value	`ByteString` The bytes for title to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Document.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter

Name	Description
unknownFields	`UnknownFieldSet`

Returns

Type	Description
Document.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)

setUpdateTime(Timestamp value)

public Document.Builder setUpdateTime(Timestamp value)

Output only. The time when the document is last updated.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
value	`Timestamp`

Returns

Type	Description
Document.Builder

setUpdateTime(Timestamp.Builder builderForValue)

public Document.Builder setUpdateTime(Timestamp.Builder builderForValue)

Output only. The time when the document is last updated.

.google.protobuf.Timestamp update_time = 8 [(.google.api.field_behavior) = OUTPUT_ONLY];

Parameter

Name	Description
builderForValue	`Builder`

Returns

Type	Description
Document.Builder

setUpdater(String value)

public Document.Builder setUpdater(String value)

The user who lastly updates the document.

string updater = 14;

Parameter

Name	Description
value	`String` The updater to set.

Returns

Type	Description
Document.Builder	This builder for chaining.

setUpdaterBytes(ByteString value)

public Document.Builder setUpdaterBytes(ByteString value)

The user who lastly updates the document.

string updater = 14;

Parameter

Name	Description
value	`ByteString` The bytes for updater to set.

Returns

Type	Description
Document.Builder	This builder for chaining.