com.google.cloud.documentai.v1beta3

Enum SummaryOptions.Format

java.lang.Object

java.lang.Enum<SummaryOptions.Format>

com.google.cloud.documentai.v1beta3.SummaryOptions.Format

All Implemented Interfaces:

com.google.protobuf.Internal.EnumLite, com.google.protobuf.ProtocolMessageEnum, Serializable, Comparable<SummaryOptions.Format>

Enclosing class:

SummaryOptions

public static enum SummaryOptions.Format
extends Enum<SummaryOptions.Format>
implements com.google.protobuf.ProtocolMessageEnum

 The Format enum.
 

Protobuf enum google.cloud.documentai.v1beta3.SummaryOptions.Format

Enum Constant Summary

Enum Constants

Enum Constant and Description
BULLETS Format the output in bullets.
FORMAT_UNSPECIFIED Default.
PARAGRAPH Format the output in paragraphs.
UNRECOGNIZED

Field Summary

Fields

Modifier and Type	Field and Description
static int	BULLETS_VALUE Format the output in bullets.
static int	FORMAT_UNSPECIFIED_VALUE Default.
static int	PARAGRAPH_VALUE Format the output in paragraphs.

Method Summary

Modifier and Type	Method and Description
static SummaryOptions.Format	forNumber(int value)
static com.google.protobuf.Descriptors.EnumDescriptor	getDescriptor()
com.google.protobuf.Descriptors.EnumDescriptor	getDescriptorForType()
int	getNumber()
com.google.protobuf.Descriptors.EnumValueDescriptor	getValueDescriptor()
static com.google.protobuf.Internal.EnumLiteMap<SummaryOptions.Format>	internalGetValueMap()
static SummaryOptions.Format	valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)
static SummaryOptions.Format	valueOf(int value) Deprecated. Use forNumber(int) instead.
static SummaryOptions.Format	valueOf(String name) Returns the enum constant of this type with the specified name.
static SummaryOptions.Format[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FORMAT_UNSPECIFIED

public static final SummaryOptions.Format FORMAT_UNSPECIFIED

 Default.
 

FORMAT_UNSPECIFIED = 0;

PARAGRAPH

public static final SummaryOptions.Format PARAGRAPH

 Format the output in paragraphs.
 

PARAGRAPH = 1;

BULLETS

public static final SummaryOptions.Format BULLETS

 Format the output in bullets.
 

BULLETS = 2;

UNRECOGNIZED

public static final SummaryOptions.Format UNRECOGNIZED

Field Detail

FORMAT_UNSPECIFIED_VALUE

public static final int FORMAT_UNSPECIFIED_VALUE

 Default.
 

FORMAT_UNSPECIFIED = 0;

See Also:

Constant Field Values

PARAGRAPH_VALUE

public static final int PARAGRAPH_VALUE

 Format the output in paragraphs.
 

PARAGRAPH = 1;

See Also:

Constant Field Values

BULLETS_VALUE

public static final int BULLETS_VALUE

 Format the output in bullets.
 

BULLETS = 2;

See Also:

Constant Field Values

Method Detail

values

public static SummaryOptions.Format[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SummaryOptions.Format c : SummaryOptions.Format.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static SummaryOptions.Format valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

getNumber

public final int getNumber()

Specified by:

getNumber in interface com.google.protobuf.Internal.EnumLite

Specified by:

getNumber in interface com.google.protobuf.ProtocolMessageEnum

valueOf

@Deprecated
public static SummaryOptions.Format valueOf(int value)

Deprecated. Use forNumber(int) instead.

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

forNumber

public static SummaryOptions.Format forNumber(int value)

Parameters:

value - The numeric wire value of the corresponding enum entry.

Returns:

The enum associated with the given numeric wire value.

internalGetValueMap

public static com.google.protobuf.Internal.EnumLiteMap<SummaryOptions.Format> internalGetValueMap()

getValueDescriptor

public final com.google.protobuf.Descriptors.EnumValueDescriptor getValueDescriptor()

Specified by:

getValueDescriptor in interface com.google.protobuf.ProtocolMessageEnum

getDescriptorForType

public final com.google.protobuf.Descriptors.EnumDescriptor getDescriptorForType()

Specified by:

getDescriptorForType in interface com.google.protobuf.ProtocolMessageEnum

getDescriptor

public static final com.google.protobuf.Descriptors.EnumDescriptor getDescriptor()

valueOf

public static SummaryOptions.Format valueOf(com.google.protobuf.Descriptors.EnumValueDescriptor desc)