Class SummaryOptions (2.41.0)

public final class SummaryOptions extends GeneratedMessageV3 implements SummaryOptionsOrBuilder

Metadata for document summarization.

Protobuf type google.cloud.documentai.v1beta3.SummaryOptions

Static Fields

FORMAT_FIELD_NUMBER

public static final int FORMAT_FIELD_NUMBER
Field Value
TypeDescription
int

LENGTH_FIELD_NUMBER

public static final int LENGTH_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static SummaryOptions getDefaultInstance()
Returns
TypeDescription
SummaryOptions

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

newBuilder()

public static SummaryOptions.Builder newBuilder()
Returns
TypeDescription
SummaryOptions.Builder

newBuilder(SummaryOptions prototype)

public static SummaryOptions.Builder newBuilder(SummaryOptions prototype)
Parameter
NameDescription
prototypeSummaryOptions
Returns
TypeDescription
SummaryOptions.Builder

parseDelimitedFrom(InputStream input)

public static SummaryOptions parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SummaryOptions
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SummaryOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SummaryOptions
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static SummaryOptions parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
SummaryOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static SummaryOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SummaryOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static SummaryOptions parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
SummaryOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static SummaryOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SummaryOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static SummaryOptions parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
SummaryOptions
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static SummaryOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SummaryOptions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static SummaryOptions parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
SummaryOptions
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static SummaryOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SummaryOptions
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static SummaryOptions parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
SummaryOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static SummaryOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
SummaryOptions
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

public static Parser<SummaryOptions> parser()
Returns
TypeDescription
Parser<SummaryOptions>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

public SummaryOptions getDefaultInstanceForType()
Returns
TypeDescription
SummaryOptions

getFormat()

public SummaryOptions.Format getFormat()

The format the summary should be in.

.google.cloud.documentai.v1beta3.SummaryOptions.Format format = 2;

Returns
TypeDescription
SummaryOptions.Format

The format.

getFormatValue()

public int getFormatValue()

The format the summary should be in.

.google.cloud.documentai.v1beta3.SummaryOptions.Format format = 2;

Returns
TypeDescription
int

The enum numeric value on the wire for format.

getLength()

public SummaryOptions.Length getLength()

How long the summary should be.

.google.cloud.documentai.v1beta3.SummaryOptions.Length length = 1;

Returns
TypeDescription
SummaryOptions.Length

The length.

getLengthValue()

public int getLengthValue()

How long the summary should be.

.google.cloud.documentai.v1beta3.SummaryOptions.Length length = 1;

Returns
TypeDescription
int

The enum numeric value on the wire for length.

getParserForType()

public Parser<SummaryOptions> getParserForType()
Returns
TypeDescription
Parser<SummaryOptions>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public SummaryOptions.Builder newBuilderForType()
Returns
TypeDescription
SummaryOptions.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected SummaryOptions.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
SummaryOptions.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public SummaryOptions.Builder toBuilder()
Returns
TypeDescription
SummaryOptions.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides
Exceptions
TypeDescription
IOException