public final class SummaryOptions extends GeneratedMessage implements SummaryOptionsOrBuilderMetadata for document summarization.
Protobuf type google.cloud.documentai.v1beta3.SummaryOptions
Inheritance
Object > AbstractMessageLite<MessageType,BuilderType> > AbstractMessage > GeneratedMessage > SummaryOptionsImplements
SummaryOptionsOrBuilderStatic Fields
FORMAT_FIELD_NUMBER
public static final int FORMAT_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
LENGTH_FIELD_NUMBER
public static final int LENGTH_FIELD_NUMBER| Field Value | |
|---|---|
| Type | Description |
int |
|
Static Methods
getDefaultInstance()
public static SummaryOptions getDefaultInstance()| Returns | |
|---|---|
| Type | Description |
SummaryOptions |
|
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Returns | |
|---|---|
| Type | Description |
Descriptor |
|
newBuilder()
public static SummaryOptions.Builder newBuilder()| Returns | |
|---|---|
| Type | Description |
SummaryOptions.Builder |
|
newBuilder(SummaryOptions prototype)
public static SummaryOptions.Builder newBuilder(SummaryOptions prototype)| Parameter | |
|---|---|
| Name | Description |
prototype |
SummaryOptions |
| Returns | |
|---|---|
| Type | Description |
SummaryOptions.Builder |
|
parseDelimitedFrom(InputStream input)
public static SummaryOptions parseDelimitedFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
SummaryOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SummaryOptions parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SummaryOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(byte[] data)
public static SummaryOptions parseFrom(byte[] data)| Parameter | |
|---|---|
| Name | Description |
data |
byte[] |
| Returns | |
|---|---|
| Type | Description |
SummaryOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
public static SummaryOptions parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
byte[] |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SummaryOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data)
public static SummaryOptions parseFrom(ByteString data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteString |
| Returns | |
|---|---|
| Type | Description |
SummaryOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
public static SummaryOptions parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteString |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SummaryOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(CodedInputStream input)
public static SummaryOptions parseFrom(CodedInputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
CodedInputStream |
| Returns | |
|---|---|
| Type | Description |
SummaryOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public static SummaryOptions parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
CodedInputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SummaryOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input)
public static SummaryOptions parseFrom(InputStream input)| Parameter | |
|---|---|
| Name | Description |
input |
InputStream |
| Returns | |
|---|---|
| Type | Description |
SummaryOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
public static SummaryOptions parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
input |
InputStream |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SummaryOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|
parseFrom(ByteBuffer data)
public static SummaryOptions parseFrom(ByteBuffer data)| Parameter | |
|---|---|
| Name | Description |
data |
ByteBuffer |
| Returns | |
|---|---|
| Type | Description |
SummaryOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
public static SummaryOptions parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)| Parameters | |
|---|---|
| Name | Description |
data |
ByteBuffer |
extensionRegistry |
ExtensionRegistryLite |
| Returns | |
|---|---|
| Type | Description |
SummaryOptions |
|
| Exceptions | |
|---|---|
| Type | Description |
InvalidProtocolBufferException |
|
parser()
public static Parser<SummaryOptions> parser()| Returns | |
|---|---|
| Type | Description |
Parser<SummaryOptions> |
|
Methods
equals(Object obj)
public boolean equals(Object obj)| Parameter | |
|---|---|
| Name | Description |
obj |
Object |
| Returns | |
|---|---|
| Type | Description |
boolean |
|
getDefaultInstanceForType()
public SummaryOptions getDefaultInstanceForType()| Returns | |
|---|---|
| Type | Description |
SummaryOptions |
|
getFormat()
public SummaryOptions.Format getFormat()The format the summary should be in.
.google.cloud.documentai.v1beta3.SummaryOptions.Format format = 2;
| Returns | |
|---|---|
| Type | Description |
SummaryOptions.Format |
The format. |
getFormatValue()
public int getFormatValue()The format the summary should be in.
.google.cloud.documentai.v1beta3.SummaryOptions.Format format = 2;
| Returns | |
|---|---|
| Type | Description |
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 | |
|---|---|
| Type | Description |
SummaryOptions.Length |
The length. |
getLengthValue()
public int getLengthValue()How long the summary should be.
.google.cloud.documentai.v1beta3.SummaryOptions.Length length = 1;
| Returns | |
|---|---|
| Type | Description |
int |
The enum numeric value on the wire for length. |
getParserForType()
public Parser<SummaryOptions> getParserForType()| Returns | |
|---|---|
| Type | Description |
Parser<SummaryOptions> |
|
getSerializedSize()
public int getSerializedSize()| Returns | |
|---|---|
| Type | Description |
int |
|
hashCode()
public int hashCode()| Returns | |
|---|---|
| Type | Description |
int |
|
internalGetFieldAccessorTable()
protected GeneratedMessage.FieldAccessorTable internalGetFieldAccessorTable()| Returns | |
|---|---|
| Type | Description |
FieldAccessorTable |
|
isInitialized()
public final boolean isInitialized()| Returns | |
|---|---|
| Type | Description |
boolean |
|
newBuilderForType()
public SummaryOptions.Builder newBuilderForType()| Returns | |
|---|---|
| Type | Description |
SummaryOptions.Builder |
|
newBuilderForType(AbstractMessage.BuilderParent parent)
protected SummaryOptions.Builder newBuilderForType(AbstractMessage.BuilderParent parent)| Parameter | |
|---|---|
| Name | Description |
parent |
BuilderParent |
| Returns | |
|---|---|
| Type | Description |
SummaryOptions.Builder |
|
toBuilder()
public SummaryOptions.Builder toBuilder()| Returns | |
|---|---|
| Type | Description |
SummaryOptions.Builder |
|
writeTo(CodedOutputStream output)
public void writeTo(CodedOutputStream output)| Parameter | |
|---|---|
| Name | Description |
output |
CodedOutputStream |
| Exceptions | |
|---|---|
| Type | Description |
IOException |
|