Class KeyValuePairHint

public final class KeyValuePairHint extends GeneratedMessageV3 implements KeyValuePairHintOrBuilder

User-provided hint for key value pair.

Protobuf type google.cloud.documentai.v1beta1.KeyValuePairHint

Fields

KEY_FIELD_NUMBER

public static final int KEY_FIELD_NUMBER
Field Value
TypeDescription
int

VALUE_TYPES_FIELD_NUMBER

public static final int VALUE_TYPES_FIELD_NUMBER
Field Value
TypeDescription
int

Methods

equals(Object obj)

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

getDefaultInstance()

public static KeyValuePairHint getDefaultInstance()
Returns
TypeDescription
KeyValuePairHint

getDefaultInstanceForType()

public KeyValuePairHint getDefaultInstanceForType()
Returns
TypeDescription
KeyValuePairHint

getDescriptor()

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

getKey()

public String getKey()

The key text for the hint.

string key = 1;

Returns
TypeDescription
String

The key.

getKeyBytes()

public ByteString getKeyBytes()

The key text for the hint.

string key = 1;

Returns
TypeDescription
ByteString

The bytes for key.

getParserForType()

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

getSerializedSize()

public int getSerializedSize()
Returns
TypeDescription
int
Overrides

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

getValueTypes(int index)

public String getValueTypes(int index)

Type of the value. This is case-insensitive, and could be one of: ADDRESS, LOCATION, ORGANIZATION, PERSON, PHONE_NUMBER, ID, NUMBER, EMAIL, PRICE, TERMS, DATE, NAME. Types not in this list will be ignored.

repeated string value_types = 2;

Parameter
NameDescription
indexint

The index of the element to return.

Returns
TypeDescription
String

The valueTypes at the given index.

getValueTypesBytes(int index)

public ByteString getValueTypesBytes(int index)

Type of the value. This is case-insensitive, and could be one of: ADDRESS, LOCATION, ORGANIZATION, PERSON, PHONE_NUMBER, ID, NUMBER, EMAIL, PRICE, TERMS, DATE, NAME. Types not in this list will be ignored.

repeated string value_types = 2;

Parameter
NameDescription
indexint

The index of the value to return.

Returns
TypeDescription
ByteString

The bytes of the valueTypes at the given index.

getValueTypesCount()

public int getValueTypesCount()

Type of the value. This is case-insensitive, and could be one of: ADDRESS, LOCATION, ORGANIZATION, PERSON, PHONE_NUMBER, ID, NUMBER, EMAIL, PRICE, TERMS, DATE, NAME. Types not in this list will be ignored.

repeated string value_types = 2;

Returns
TypeDescription
int

The count of valueTypes.

getValueTypesList()

public ProtocolStringList getValueTypesList()

Type of the value. This is case-insensitive, and could be one of: ADDRESS, LOCATION, ORGANIZATION, PERSON, PHONE_NUMBER, ID, NUMBER, EMAIL, PRICE, TERMS, DATE, NAME. Types not in this list will be ignored.

repeated string value_types = 2;

Returns
TypeDescription
ProtocolStringList

A list containing the valueTypes.

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

newBuilder()

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

newBuilder(KeyValuePairHint prototype)

public static KeyValuePairHint.Builder newBuilder(KeyValuePairHint prototype)
Parameter
NameDescription
prototypeKeyValuePairHint
Returns
TypeDescription
KeyValuePairHint.Builder

newBuilderForType()

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

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

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

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

parseDelimitedFrom(InputStream input)

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

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(byte[] data)

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

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteString data)

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

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

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

parseFrom(CodedInputStream input)

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

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(InputStream input)

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

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

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

parseFrom(ByteBuffer data)

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

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

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

parser()

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

toBuilder()

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

writeTo(CodedOutputStream output)

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