Class DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig (0.60.0)

public static final class DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig extends GeneratedMessageV3 implements DocumentProcessingConfig.ParsingConfig.LayoutParsingConfigOrBuilder

The layout parsing configurations for documents.

Protobuf type google.cloud.discoveryengine.v1.DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig

Inheritance

Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessageV3 > DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig

Static Fields

ENABLE_IMAGE_ANNOTATION_FIELD_NUMBER

public static final int ENABLE_IMAGE_ANNOTATION_FIELD_NUMBER
Field Value
Type Description
int

ENABLE_TABLE_ANNOTATION_FIELD_NUMBER

public static final int ENABLE_TABLE_ANNOTATION_FIELD_NUMBER
Field Value
Type Description
int

EXCLUDE_HTML_CLASSES_FIELD_NUMBER

public static final int EXCLUDE_HTML_CLASSES_FIELD_NUMBER
Field Value
Type Description
int

EXCLUDE_HTML_ELEMENTS_FIELD_NUMBER

public static final int EXCLUDE_HTML_ELEMENTS_FIELD_NUMBER
Field Value
Type Description
int

EXCLUDE_HTML_IDS_FIELD_NUMBER

public static final int EXCLUDE_HTML_IDS_FIELD_NUMBER
Field Value
Type Description
int

STRUCTURED_CONTENT_TYPES_FIELD_NUMBER

public static final int STRUCTURED_CONTENT_TYPES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig getDefaultInstance()
Returns
Type Description
DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig

getDescriptor()

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

newBuilder()

public static DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig.Builder newBuilder()
Returns
Type Description
DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig.Builder

newBuilder(DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig prototype)

public static DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig.Builder newBuilder(DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig prototype)
Parameter
Name Description
prototype DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig
Returns
Type Description
DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig.Builder

parseDelimitedFrom(InputStream input)

public static DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig> parser()
Returns
Type Description
Parser<LayoutParsingConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig getDefaultInstanceForType()
Returns
Type Description
DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig

getEnableImageAnnotation()

public boolean getEnableImageAnnotation()

Optional. If true, the LLM based annotation is added to the image during parsing.

bool enable_image_annotation = 2 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The enableImageAnnotation.

getEnableTableAnnotation()

public boolean getEnableTableAnnotation()

Optional. If true, the LLM based annotation is added to the table during parsing.

bool enable_table_annotation = 1 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
boolean

The enableTableAnnotation.

getExcludeHtmlClasses(int index)

public String getExcludeHtmlClasses(int index)

Optional. List of HTML classes to exclude from the parsed content.

repeated string exclude_html_classes = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The excludeHtmlClasses at the given index.

getExcludeHtmlClassesBytes(int index)

public ByteString getExcludeHtmlClassesBytes(int index)

Optional. List of HTML classes to exclude from the parsed content.

repeated string exclude_html_classes = 11 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the excludeHtmlClasses at the given index.

getExcludeHtmlClassesCount()

public int getExcludeHtmlClassesCount()

Optional. List of HTML classes to exclude from the parsed content.

repeated string exclude_html_classes = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of excludeHtmlClasses.

getExcludeHtmlClassesList()

public ProtocolStringList getExcludeHtmlClassesList()

Optional. List of HTML classes to exclude from the parsed content.

repeated string exclude_html_classes = 11 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the excludeHtmlClasses.

getExcludeHtmlElements(int index)

public String getExcludeHtmlElements(int index)

Optional. List of HTML elements to exclude from the parsed content.

repeated string exclude_html_elements = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The excludeHtmlElements at the given index.

getExcludeHtmlElementsBytes(int index)

public ByteString getExcludeHtmlElementsBytes(int index)

Optional. List of HTML elements to exclude from the parsed content.

repeated string exclude_html_elements = 10 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the excludeHtmlElements at the given index.

getExcludeHtmlElementsCount()

public int getExcludeHtmlElementsCount()

Optional. List of HTML elements to exclude from the parsed content.

repeated string exclude_html_elements = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of excludeHtmlElements.

getExcludeHtmlElementsList()

public ProtocolStringList getExcludeHtmlElementsList()

Optional. List of HTML elements to exclude from the parsed content.

repeated string exclude_html_elements = 10 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the excludeHtmlElements.

getExcludeHtmlIds(int index)

public String getExcludeHtmlIds(int index)

Optional. List of HTML ids to exclude from the parsed content.

repeated string exclude_html_ids = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The excludeHtmlIds at the given index.

getExcludeHtmlIdsBytes(int index)

public ByteString getExcludeHtmlIdsBytes(int index)

Optional. List of HTML ids to exclude from the parsed content.

repeated string exclude_html_ids = 12 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the excludeHtmlIds at the given index.

getExcludeHtmlIdsCount()

public int getExcludeHtmlIdsCount()

Optional. List of HTML ids to exclude from the parsed content.

repeated string exclude_html_ids = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of excludeHtmlIds.

getExcludeHtmlIdsList()

public ProtocolStringList getExcludeHtmlIdsList()

Optional. List of HTML ids to exclude from the parsed content.

repeated string exclude_html_ids = 12 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the excludeHtmlIds.

getParserForType()

public Parser<DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig> getParserForType()
Returns
Type Description
Parser<LayoutParsingConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
Overrides

getStructuredContentTypes(int index)

public String getStructuredContentTypes(int index)

Optional. Contains the required structure types to extract from the document. Supported values:

  • shareholder-structure

repeated string structured_content_types = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the element to return.

Returns
Type Description
String

The structuredContentTypes at the given index.

getStructuredContentTypesBytes(int index)

public ByteString getStructuredContentTypesBytes(int index)

Optional. Contains the required structure types to extract from the document. Supported values:

  • shareholder-structure

repeated string structured_content_types = 9 [(.google.api.field_behavior) = OPTIONAL];

Parameter
Name Description
index int

The index of the value to return.

Returns
Type Description
ByteString

The bytes of the structuredContentTypes at the given index.

getStructuredContentTypesCount()

public int getStructuredContentTypesCount()

Optional. Contains the required structure types to extract from the document. Supported values:

  • shareholder-structure

repeated string structured_content_types = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
int

The count of structuredContentTypes.

getStructuredContentTypesList()

public ProtocolStringList getStructuredContentTypesList()

Optional. Contains the required structure types to extract from the document. Supported values:

  • shareholder-structure

repeated string structured_content_types = 9 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type Description
ProtocolStringList

A list containing the structuredContentTypes.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

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

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig.Builder newBuilderForType()
Returns
Type Description
DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig.Builder toBuilder()
Returns
Type Description
DocumentProcessingConfig.ParsingConfig.LayoutParsingConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException