Class DocumentMetadata.Builder (2.48.0) 

public static final class DocumentMetadata.Builder extends GeneratedMessageV3.Builder<DocumentMetadata.Builder> implements DocumentMetadataOrBuilder

Metadata about a document.

Protobuf type google.cloud.documentai.v1beta3.DocumentMetadata

Inheritance

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public DocumentMetadata.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DocumentMetadata.Builder
Overrides

build()

public DocumentMetadata build()
Returns
Type Description
DocumentMetadata

buildPartial()

public DocumentMetadata buildPartial()
Returns
Type Description
DocumentMetadata

clear()

public DocumentMetadata.Builder clear()
Returns
Type Description
DocumentMetadata.Builder
Overrides

clearDatasetType()

public DocumentMetadata.Builder clearDatasetType()

Type of the dataset split to which the document belongs.

.google.cloud.documentai.v1beta3.DatasetSplitType dataset_type = 3;

Returns
Type Description
DocumentMetadata.Builder

This builder for chaining.

clearDisplayName()

public DocumentMetadata.Builder clearDisplayName()

The display name of the document.

string display_name = 6;

Returns
Type Description
DocumentMetadata.Builder

This builder for chaining.

clearDocumentId()

public DocumentMetadata.Builder clearDocumentId()

Document identifier.

.google.cloud.documentai.v1beta3.DocumentId document_id = 1;

Returns
Type Description
DocumentMetadata.Builder

clearField(Descriptors.FieldDescriptor field)

public DocumentMetadata.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
Name Description
field FieldDescriptor
Returns
Type Description
DocumentMetadata.Builder
Overrides

clearLabelingState()

public DocumentMetadata.Builder clearLabelingState()

Labeling state of the document.

.google.cloud.documentai.v1beta3.DocumentLabelingState labeling_state = 5;

Returns
Type Description
DocumentMetadata.Builder

This builder for chaining.

clearOneof(Descriptors.OneofDescriptor oneof)

public DocumentMetadata.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
Name Description
oneof OneofDescriptor
Returns
Type Description
DocumentMetadata.Builder
Overrides

clearPageCount()

public DocumentMetadata.Builder clearPageCount()

Number of pages in the document.

int32 page_count = 2;

Returns
Type Description
DocumentMetadata.Builder

This builder for chaining.

clone()

public DocumentMetadata.Builder clone()
Returns
Type Description
DocumentMetadata.Builder
Overrides

getDatasetType()

public DatasetSplitType getDatasetType()

Type of the dataset split to which the document belongs.

.google.cloud.documentai.v1beta3.DatasetSplitType dataset_type = 3;

Returns
Type Description
DatasetSplitType

The datasetType.

getDatasetTypeValue()

public int getDatasetTypeValue()

Type of the dataset split to which the document belongs.

.google.cloud.documentai.v1beta3.DatasetSplitType dataset_type = 3;

Returns
Type Description
int

The enum numeric value on the wire for datasetType.

getDefaultInstanceForType()

public DocumentMetadata getDefaultInstanceForType()
Returns
Type Description
DocumentMetadata

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
Type Description
Descriptor
Overrides

getDisplayName()

public String getDisplayName()

The display name of the document.

string display_name = 6;

Returns
Type Description
String

The displayName.

getDisplayNameBytes()

public ByteString getDisplayNameBytes()

The display name of the document.

string display_name = 6;

Returns
Type Description
ByteString

The bytes for displayName.

getDocumentId()

public DocumentId getDocumentId()

Document identifier.

.google.cloud.documentai.v1beta3.DocumentId document_id = 1;

Returns
Type Description
DocumentId

The documentId.

getDocumentIdBuilder()

public DocumentId.Builder getDocumentIdBuilder()

Document identifier.

.google.cloud.documentai.v1beta3.DocumentId document_id = 1;

Returns
Type Description
DocumentId.Builder

getDocumentIdOrBuilder()

public DocumentIdOrBuilder getDocumentIdOrBuilder()

Document identifier.

.google.cloud.documentai.v1beta3.DocumentId document_id = 1;

Returns
Type Description
DocumentIdOrBuilder

getLabelingState()

public DocumentLabelingState getLabelingState()

Labeling state of the document.

.google.cloud.documentai.v1beta3.DocumentLabelingState labeling_state = 5;

Returns
Type Description
DocumentLabelingState

The labelingState.

getLabelingStateValue()

public int getLabelingStateValue()

Labeling state of the document.

.google.cloud.documentai.v1beta3.DocumentLabelingState labeling_state = 5;

Returns
Type Description
int

The enum numeric value on the wire for labelingState.

getPageCount()

public int getPageCount()

Number of pages in the document.

int32 page_count = 2;

Returns
Type Description
int

The pageCount.

hasDocumentId()

public boolean hasDocumentId()

Document identifier.

.google.cloud.documentai.v1beta3.DocumentId document_id = 1;

Returns
Type Description
boolean

Whether the documentId field is set.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

mergeDocumentId(DocumentId value)

public DocumentMetadata.Builder mergeDocumentId(DocumentId value)

Document identifier.

.google.cloud.documentai.v1beta3.DocumentId document_id = 1;

Parameter
Name Description
value DocumentId
Returns
Type Description
DocumentMetadata.Builder

mergeFrom(DocumentMetadata other)

public DocumentMetadata.Builder mergeFrom(DocumentMetadata other)
Parameter
Name Description
other DocumentMetadata
Returns
Type Description
DocumentMetadata.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public DocumentMetadata.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentMetadata.Builder
Overrides
Exceptions
Type Description
IOException

mergeFrom(Message other)

public DocumentMetadata.Builder mergeFrom(Message other)
Parameter
Name Description
other Message
Returns
Type Description
DocumentMetadata.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final DocumentMetadata.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DocumentMetadata.Builder
Overrides

setDatasetType(DatasetSplitType value)

public DocumentMetadata.Builder setDatasetType(DatasetSplitType value)

Type of the dataset split to which the document belongs.

.google.cloud.documentai.v1beta3.DatasetSplitType dataset_type = 3;

Parameter
Name Description
value DatasetSplitType

The datasetType to set.
Returns
Type Description
DocumentMetadata.Builder

This builder for chaining.

setDatasetTypeValue(int value)

public DocumentMetadata.Builder setDatasetTypeValue(int value)

Type of the dataset split to which the document belongs.

.google.cloud.documentai.v1beta3.DatasetSplitType dataset_type = 3;

Parameter
Name Description
value int

The enum numeric value on the wire for datasetType to set.
Returns
Type Description
DocumentMetadata.Builder

This builder for chaining.

setDisplayName(String value)

public DocumentMetadata.Builder setDisplayName(String value)

The display name of the document.

string display_name = 6;

Parameter
Name Description
value String

The displayName to set.
Returns
Type Description
DocumentMetadata.Builder

This builder for chaining.

setDisplayNameBytes(ByteString value)

public DocumentMetadata.Builder setDisplayNameBytes(ByteString value)

The display name of the document.

string display_name = 6;

Parameter
Name Description
value ByteString

The bytes for displayName to set.
Returns
Type Description
DocumentMetadata.Builder

This builder for chaining.

setDocumentId(DocumentId value)

public DocumentMetadata.Builder setDocumentId(DocumentId value)

Document identifier.

.google.cloud.documentai.v1beta3.DocumentId document_id = 1;

Parameter
Name Description
value DocumentId
Returns
Type Description
DocumentMetadata.Builder

setDocumentId(DocumentId.Builder builderForValue)

public DocumentMetadata.Builder setDocumentId(DocumentId.Builder builderForValue)

Document identifier.

.google.cloud.documentai.v1beta3.DocumentId document_id = 1;

Parameter
Name Description
builderForValue DocumentId.Builder
Returns
Type Description
DocumentMetadata.Builder

setField(Descriptors.FieldDescriptor field, Object value)

public DocumentMetadata.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
Name Description
field FieldDescriptor
value Object
Returns
Type Description
DocumentMetadata.Builder
Overrides

setLabelingState(DocumentLabelingState value)

public DocumentMetadata.Builder setLabelingState(DocumentLabelingState value)

Labeling state of the document.

.google.cloud.documentai.v1beta3.DocumentLabelingState labeling_state = 5;

Parameter
Name Description
value DocumentLabelingState

The labelingState to set.
Returns
Type Description
DocumentMetadata.Builder

This builder for chaining.

setLabelingStateValue(int value)

public DocumentMetadata.Builder setLabelingStateValue(int value)

Labeling state of the document.

.google.cloud.documentai.v1beta3.DocumentLabelingState labeling_state = 5;

Parameter
Name Description
value int

The enum numeric value on the wire for labelingState to set.
Returns
Type Description
DocumentMetadata.Builder

This builder for chaining.

setPageCount(int value)

public DocumentMetadata.Builder setPageCount(int value)

Number of pages in the document.

int32 page_count = 2;

Parameter
Name Description
value int

The pageCount to set.
Returns
Type Description
DocumentMetadata.Builder

This builder for chaining.

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

public DocumentMetadata.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
Name Description
field FieldDescriptor
index int
value Object
Returns
Type Description
DocumentMetadata.Builder
Overrides

setUnknownFields(UnknownFieldSet unknownFields)

public final DocumentMetadata.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
Name Description
unknownFields UnknownFieldSet
Returns
Type Description
DocumentMetadata.Builder
Overrides