KeyValuePairHint.Builder (proto-google-cloud-document-ai-v1beta1 0.55.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<KeyValuePairHint.Builder>
    - - com.google.cloud.documentai.v1beta1.KeyValuePairHint.Builder

All Implemented Interfaces:

KeyValuePairHintOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

KeyValuePairHint
```
public static final class KeyValuePairHint.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<KeyValuePairHint.Builder>
implements KeyValuePairHintOrBuilder
```
```
 User-provided hint for key value pair.
 
```
Protobuf type google.cloud.documentai.v1beta1.KeyValuePairHint

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`KeyValuePairHint.Builder`	`addAllValueTypes(Iterable<String> values)` Type of the value.
`KeyValuePairHint.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`KeyValuePairHint.Builder`	`addValueTypes(String value)` Type of the value.
`KeyValuePairHint.Builder`	`addValueTypesBytes(com.google.protobuf.ByteString value)` Type of the value.
`KeyValuePairHint`	`build()`
`KeyValuePairHint`	`buildPartial()`
`KeyValuePairHint.Builder`	`clear()`
`KeyValuePairHint.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`KeyValuePairHint.Builder`	`clearKey()` The key text for the hint.
`KeyValuePairHint.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`KeyValuePairHint.Builder`	`clearValueTypes()` Type of the value.
`KeyValuePairHint.Builder`	`clone()`
`KeyValuePairHint`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getKey()` The key text for the hint.
`com.google.protobuf.ByteString`	`getKeyBytes()` The key text for the hint.
`String`	`getValueTypes(int index)` Type of the value.
`com.google.protobuf.ByteString`	`getValueTypesBytes(int index)` Type of the value.
`int`	`getValueTypesCount()` Type of the value.
`com.google.protobuf.ProtocolStringList`	`getValueTypesList()` Type of the value.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`KeyValuePairHint.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`KeyValuePairHint.Builder`	`mergeFrom(KeyValuePairHint other)`
`KeyValuePairHint.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`KeyValuePairHint.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`KeyValuePairHint.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`KeyValuePairHint.Builder`	`setKey(String value)` The key text for the hint.
`KeyValuePairHint.Builder`	`setKeyBytes(com.google.protobuf.ByteString value)` The key text for the hint.
`KeyValuePairHint.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`KeyValuePairHint.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`KeyValuePairHint.Builder`	`setValueTypes(int index, String value)` Type of the value.

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, internalGetMutableMapField, internalGetMutableMapFieldReflection, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

- Method Detail
  - 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.Builder<KeyValuePairHint.Builder>
  - clear
```
public KeyValuePairHint.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<KeyValuePairHint.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<KeyValuePairHint.Builder>
  - getDefaultInstanceForType
```
public KeyValuePairHint getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public KeyValuePairHint build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public KeyValuePairHint buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public KeyValuePairHint.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<KeyValuePairHint.Builder>
  - setField
```
public KeyValuePairHint.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                         Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<KeyValuePairHint.Builder>
  - clearField
```
public KeyValuePairHint.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<KeyValuePairHint.Builder>
  - clearOneof
```
public KeyValuePairHint.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<KeyValuePairHint.Builder>
  - setRepeatedField
```
public KeyValuePairHint.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 int index,
                                                 Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<KeyValuePairHint.Builder>
  - addRepeatedField
```
public KeyValuePairHint.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                 Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<KeyValuePairHint.Builder>
  - mergeFrom
```
public KeyValuePairHint.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<KeyValuePairHint.Builder>
  - mergeFrom
```
public KeyValuePairHint.Builder mergeFrom(KeyValuePairHint other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<KeyValuePairHint.Builder>
  - mergeFrom
```
public KeyValuePairHint.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                          com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                   throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<KeyValuePairHint.Builder>
    
    Throws:
    
    IOException
  - getKey
```
public String getKey()
```
```
 The key text for the hint.
 
```
    string key = 1;
    Specified by:
    
    getKey in interface KeyValuePairHintOrBuilder
    
    Returns:
    
    The key.
  - 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.
  - setKey
```
public KeyValuePairHint.Builder setKey(String value)
```
```
 The key text for the hint.
 
```
    string key = 1;
    Parameters:
    
    value - The key to set.
    
    Returns:
    
    This builder for chaining.
  - clearKey
```
public KeyValuePairHint.Builder clearKey()
```
```
 The key text for the hint.
 
```
    string key = 1;
    Returns:
    
    This builder for chaining.
  - setKeyBytes
```
public KeyValuePairHint.Builder setKeyBytes(com.google.protobuf.ByteString value)
```
```
 The key text for the hint.
 
```
    string key = 1;
    Parameters:
    
    value - The bytes for key to set.
    
    Returns:
    
    This builder for chaining.
  - 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.
  - setValueTypes
```
public KeyValuePairHint.Builder setValueTypes(int index,
                                              String value)
```
```
 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;
    Parameters:
    
    index - The index to set the value at.
    
    value - The valueTypes to set.
    
    Returns:
    
    This builder for chaining.
  - addValueTypes
```
public KeyValuePairHint.Builder addValueTypes(String value)
```
```
 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;
    Parameters:
    
    value - The valueTypes to add.
    
    Returns:
    
    This builder for chaining.
  - addAllValueTypes
```
public KeyValuePairHint.Builder addAllValueTypes(Iterable<String> values)
```
```
 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;
    Parameters:
    
    values - The valueTypes to add.
    
    Returns:
    
    This builder for chaining.
  - clearValueTypes
```
public KeyValuePairHint.Builder clearValueTypes()
```
```
 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:
    
    This builder for chaining.
  - addValueTypesBytes
```
public KeyValuePairHint.Builder addValueTypesBytes(com.google.protobuf.ByteString value)
```
```
 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;
    Parameters:
    
    value - The bytes of the valueTypes to add.
    
    Returns:
    
    This builder for chaining.
  - setUnknownFields
```
public final KeyValuePairHint.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<KeyValuePairHint.Builder>
  - mergeUnknownFields
```
public final KeyValuePairHint.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<KeyValuePairHint.Builder>

Class KeyValuePairHint.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getKey

getKeyBytes

setKey

clearKey

setKeyBytes

getValueTypesList

getValueTypesCount

getValueTypes

getValueTypesBytes

setValueTypes

addValueTypes

addAllValueTypes

clearValueTypes

addValueTypesBytes

setUnknownFields

mergeUnknownFields