Package com.google.cloud.documentai.v1beta1

Class KeyValuePairHint

  • All Implemented Interfaces:
    KeyValuePairHintOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
    public final class KeyValuePairHint
extends com.google.protobuf.GeneratedMessageV3
implements KeyValuePairHintOrBuilder
     User-provided hint for key value pair.
    Protobuf type google.cloud.documentai.v1beta1.KeyValuePairHint
    See Also:
    Serialized Form

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  KeyValuePairHint.Builder
      User-provided hint for key value pair.

      • Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessageV3

        com.google.protobuf.GeneratedMessageV3.BuilderParent, com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>,​BuilderT extends com.google.protobuf.GeneratedMessageV3.ExtendableBuilder<MessageT,​BuilderT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessageV3.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessageV3.FieldAccessorTable, com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter

      • Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessageLite

        com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int KEY_FIELD_NUMBER  
      static int VALUE_TYPES_FIELD_NUMBER  

      • Fields inherited from class com.google.protobuf.GeneratedMessageV3

        alwaysUseFieldBuilders, unknownFields

      • Fields inherited from class com.google.protobuf.AbstractMessage

        memoizedSize

      • Fields inherited from class com.google.protobuf.AbstractMessageLite

        memoizedHashCode

    • Method Detail

      • newInstance

        protected Object newInstance​(com.google.protobuf.GeneratedMessageV3.UnusedPrivateParameter unused)
        Overrides:
        newInstance in class com.google.protobuf.GeneratedMessageV3

      • getDescriptor

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

      • internalGetFieldAccessorTable

        protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
        Specified by:
        internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3

      • getKeyBytes

        public com.google.protobuf.ByteString getKeyBytes()
         The key text for the hint.
        string key = 1;
        Specified by:
        getKeyBytes in interface KeyValuePairHintOrBuilder
        Returns:
        The bytes for key.

      • getValueTypesList

        public com.google.protobuf.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;
        Specified by:
        getValueTypesList in interface KeyValuePairHintOrBuilder
        Returns:
        A list containing the valueTypes.

      • 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;
        Specified by:
        getValueTypesCount in interface KeyValuePairHintOrBuilder
        Returns:
        The count of valueTypes.

      • getValueTypes

        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;
        Specified by:
        getValueTypes in interface KeyValuePairHintOrBuilder
        Parameters:
        index - The index of the element to return.
        Returns:
        The valueTypes at the given index.

      • getValueTypesBytes

        public com.google.protobuf.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;
        Specified by:
        getValueTypesBytes in interface KeyValuePairHintOrBuilder
        Parameters:
        index - The index of the value to return.
        Returns:
        The bytes of the valueTypes at the given index.

      • isInitialized

        public final boolean isInitialized()
        Specified by:
        isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
        Overrides:
        isInitialized in class com.google.protobuf.GeneratedMessageV3

      • writeTo

        public void writeTo​(com.google.protobuf.CodedOutputStream output)
             throws IOException
        Specified by:
        writeTo in interface com.google.protobuf.MessageLite
        Overrides:
        writeTo in class com.google.protobuf.GeneratedMessageV3
        Throws:
        IOException

      • getSerializedSize

        public int getSerializedSize()
        Specified by:
        getSerializedSize in interface com.google.protobuf.MessageLite
        Overrides:
        getSerializedSize in class com.google.protobuf.GeneratedMessageV3

      • equals

        public boolean equals​(Object obj)
        Specified by:
        equals in interface com.google.protobuf.Message
        Overrides:
        equals in class com.google.protobuf.AbstractMessage

      • hashCode

        public int hashCode()
        Specified by:
        hashCode in interface com.google.protobuf.Message
        Overrides:
        hashCode in class com.google.protobuf.AbstractMessage

      • parseFrom

        public static KeyValuePairHint parseFrom​(ByteBuffer data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static KeyValuePairHint parseFrom​(ByteBuffer data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static KeyValuePairHint parseFrom​(com.google.protobuf.ByteString data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static KeyValuePairHint parseFrom​(com.google.protobuf.ByteString data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static KeyValuePairHint parseFrom​(byte[] data)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static KeyValuePairHint parseFrom​(byte[] data,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws com.google.protobuf.InvalidProtocolBufferException
        Throws:
        com.google.protobuf.InvalidProtocolBufferException

      • parseFrom

        public static KeyValuePairHint parseFrom​(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
        Throws:
        IOException

      • newBuilderForType

        public KeyValuePairHint.Builder newBuilderForType()
        Specified by:
        newBuilderForType in interface com.google.protobuf.Message
        Specified by:
        newBuilderForType in interface com.google.protobuf.MessageLite

      • toBuilder

        public KeyValuePairHint.Builder toBuilder()
        Specified by:
        toBuilder in interface com.google.protobuf.Message
        Specified by:
        toBuilder in interface com.google.protobuf.MessageLite

      • newBuilderForType

        protected KeyValuePairHint.Builder newBuilderForType​(com.google.protobuf.GeneratedMessageV3.BuilderParent parent)
        Specified by:
        newBuilderForType in class com.google.protobuf.GeneratedMessageV3

      • getParserForType

        public com.google.protobuf.Parser<KeyValuePairHint> getParserForType()
        Specified by:
        getParserForType in interface com.google.protobuf.Message
        Specified by:
        getParserForType in interface com.google.protobuf.MessageLite
        Overrides:
        getParserForType in class com.google.protobuf.GeneratedMessageV3

      • getDefaultInstanceForType

        public KeyValuePairHint getDefaultInstanceForType()
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
        Specified by:
        getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder