Class KeyValuePairHint (2.48.0)

public final class KeyValuePairHint extends GeneratedMessageV3 implements KeyValuePairHintOrBuilder

User-provided hint for key value pair.

Protobuf type google.cloud.documentai.v1beta1.KeyValuePairHint

Static Fields

KEY_FIELD_NUMBER

public static final int KEY_FIELD_NUMBER
Field Value
Type Description
int

VALUE_TYPES_FIELD_NUMBER

public static final int VALUE_TYPES_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static KeyValuePairHint getDefaultInstance()
Returns
Type Description
KeyValuePairHint

getDescriptor()

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

newBuilder()

public static KeyValuePairHint.Builder newBuilder()
Returns
Type Description
KeyValuePairHint.Builder

newBuilder(KeyValuePairHint prototype)

public static KeyValuePairHint.Builder newBuilder(KeyValuePairHint prototype)
Parameter
Name Description
prototype KeyValuePairHint
Returns
Type Description
KeyValuePairHint.Builder

parseDelimitedFrom(InputStream input)

public static KeyValuePairHint parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
KeyValuePairHint
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KeyValuePairHint parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KeyValuePairHint
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static KeyValuePairHint parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
KeyValuePairHint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static KeyValuePairHint parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KeyValuePairHint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static KeyValuePairHint parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
KeyValuePairHint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static KeyValuePairHint parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KeyValuePairHint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static KeyValuePairHint parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
KeyValuePairHint
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static KeyValuePairHint parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KeyValuePairHint
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static KeyValuePairHint parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
KeyValuePairHint
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static KeyValuePairHint parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KeyValuePairHint
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static KeyValuePairHint parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
KeyValuePairHint
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static KeyValuePairHint parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
KeyValuePairHint
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<KeyValuePairHint> parser()
Returns
Type Description
Parser<KeyValuePairHint>

Methods

equals(Object obj)

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

getDefaultInstanceForType()

public KeyValuePairHint getDefaultInstanceForType()
Returns
Type Description
KeyValuePairHint

getKey()

public String getKey()

The key text for the hint.

string key = 1;

Returns
Type Description
String

The key.

getKeyBytes()

public ByteString getKeyBytes()

The key text for the hint.

string key = 1;

Returns
Type Description
ByteString

The bytes for key.

getParserForType()

public Parser<KeyValuePairHint> getParserForType()
Returns
Type Description
Parser<KeyValuePairHint>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
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
Name Description
index int

The index of the element to return.

Returns
Type Description
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
Name Description
index int

The index of the value to return.

Returns
Type Description
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
Type Description
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
Type Description
ProtocolStringList

A list containing the valueTypes.

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 KeyValuePairHint.Builder newBuilderForType()
Returns
Type Description
KeyValuePairHint.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected KeyValuePairHint.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
KeyValuePairHint.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

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

toBuilder()

public KeyValuePairHint.Builder toBuilder()
Returns
Type Description
KeyValuePairHint.Builder

writeTo(CodedOutputStream output)

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