Index.IndexField.Builder (proto-google-cloud-firestore-admin-v1 1.35.0 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderType>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Index.IndexField.Builder>
    - - com.google.firestore.admin.v1.Index.IndexField.Builder

All Implemented Interfaces:

Index.IndexFieldOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:

Index.IndexField
```
public static final class Index.IndexField.Builder
extends com.google.protobuf.GeneratedMessageV3.Builder<Index.IndexField.Builder>
implements Index.IndexFieldOrBuilder
```
```
 A field in an index.
 The field_path describes which field is indexed, the value_mode describes
 how the field value is indexed.
 
```
Protobuf type google.firestore.admin.v1.Index.IndexField

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Index.IndexField.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Index.IndexField`	`build()`
`Index.IndexField`	`buildPartial()`
`Index.IndexField.Builder`	`clear()`
`Index.IndexField.Builder`	`clearArrayConfig()` Indicates that this field supports operations on `array_value`s.
`Index.IndexField.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Index.IndexField.Builder`	`clearFieldPath()` Can be __name__.
`Index.IndexField.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Index.IndexField.Builder`	`clearOrder()` Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
`Index.IndexField.Builder`	`clearValueMode()`
`Index.IndexField.Builder`	`clone()`
`Index.IndexField.ArrayConfig`	`getArrayConfig()` Indicates that this field supports operations on `array_value`s.
`int`	`getArrayConfigValue()` Indicates that this field supports operations on `array_value`s.
`Index.IndexField`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`String`	`getFieldPath()` Can be __name__.
`com.google.protobuf.ByteString`	`getFieldPathBytes()` Can be __name__.
`Index.IndexField.Order`	`getOrder()` Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
`int`	`getOrderValue()` Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
`Index.IndexField.ValueModeCase`	`getValueModeCase()`
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Index.IndexField.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Index.IndexField.Builder`	`mergeFrom(Index.IndexField other)`
`Index.IndexField.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Index.IndexField.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Index.IndexField.Builder`	`setArrayConfig(Index.IndexField.ArrayConfig value)` Indicates that this field supports operations on `array_value`s.
`Index.IndexField.Builder`	`setArrayConfigValue(int value)` Indicates that this field supports operations on `array_value`s.
`Index.IndexField.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Index.IndexField.Builder`	`setFieldPath(String value)` Can be __name__.
`Index.IndexField.Builder`	`setFieldPathBytes(com.google.protobuf.ByteString value)` Can be __name__.
`Index.IndexField.Builder`	`setOrder(Index.IndexField.Order value)` Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
`Index.IndexField.Builder`	`setOrderValue(int value)` Indicates that this field supports ordering by the specified order or comparing using =, <, <=, >, >=.
`Index.IndexField.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`Index.IndexField.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

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

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

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeFrom, 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.MessageLite.Builder
mergeFrom

- 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<Index.IndexField.Builder>
  - clear
```
public Index.IndexField.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<Index.IndexField.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<Index.IndexField.Builder>
  - getDefaultInstanceForType
```
public Index.IndexField getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public Index.IndexField build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public Index.IndexField buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public Index.IndexField.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<Index.IndexField.Builder>
  - setField
```
public Index.IndexField.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<Index.IndexField.Builder>
  - clearField
```
public Index.IndexField.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<Index.IndexField.Builder>
  - clearOneof
```
public Index.IndexField.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<Index.IndexField.Builder>
  - setRepeatedField
```
public Index.IndexField.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<Index.IndexField.Builder>
  - addRepeatedField
```
public Index.IndexField.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<Index.IndexField.Builder>
  - mergeFrom
```
public Index.IndexField.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<Index.IndexField.Builder>
  - mergeFrom
```
public Index.IndexField.Builder mergeFrom(Index.IndexField other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Index.IndexField.Builder>
  - mergeFrom
```
public Index.IndexField.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<Index.IndexField.Builder>
    
    Throws:
    
    IOException
  - getValueModeCase
```
public Index.IndexField.ValueModeCase getValueModeCase()
```
    Specified by:
    
    getValueModeCase in interface Index.IndexFieldOrBuilder
  - clearValueMode
```
public Index.IndexField.Builder clearValueMode()
```
  - getFieldPath
```
public String getFieldPath()
```
```
 Can be __name__.
 For single field indexes, this must match the name of the field or may
 be omitted.
 
```
    string field_path = 1;
    Specified by:
    
    getFieldPath in interface Index.IndexFieldOrBuilder
    
    Returns:
    
    The fieldPath.
  - getFieldPathBytes
```
public com.google.protobuf.ByteString getFieldPathBytes()
```
```
 Can be __name__.
 For single field indexes, this must match the name of the field or may
 be omitted.
 
```
    string field_path = 1;
    Specified by:
    
    getFieldPathBytes in interface Index.IndexFieldOrBuilder
    
    Returns:
    
    The bytes for fieldPath.
  - setFieldPath
```
public Index.IndexField.Builder setFieldPath(String value)
```
```
 Can be __name__.
 For single field indexes, this must match the name of the field or may
 be omitted.
 
```
    string field_path = 1;
    Parameters:
    
    value - The fieldPath to set.
    
    Returns:
    
    This builder for chaining.
  - clearFieldPath
```
public Index.IndexField.Builder clearFieldPath()
```
```
 Can be __name__.
 For single field indexes, this must match the name of the field or may
 be omitted.
 
```
    string field_path = 1;
    Returns:
    
    This builder for chaining.
  - setFieldPathBytes
```
public Index.IndexField.Builder setFieldPathBytes(com.google.protobuf.ByteString value)
```
```
 Can be __name__.
 For single field indexes, this must match the name of the field or may
 be omitted.
 
```
    string field_path = 1;
    Parameters:
    
    value - The bytes for fieldPath to set.
    
    Returns:
    
    This builder for chaining.
  - getOrderValue
```
public int getOrderValue()
```
```
 Indicates that this field supports ordering by the specified order or
 comparing using =, <, <=, >, >=.
 
```
    .google.firestore.admin.v1.Index.IndexField.Order order = 2;
    Specified by:
    
    getOrderValue in interface Index.IndexFieldOrBuilder
    
    Returns:
    
    The enum numeric value on the wire for order.
  - setOrderValue
```
public Index.IndexField.Builder setOrderValue(int value)
```
```
 Indicates that this field supports ordering by the specified order or
 comparing using =, <, <=, >, >=.
 
```
    .google.firestore.admin.v1.Index.IndexField.Order order = 2;
    Parameters:
    
    value - The enum numeric value on the wire for order to set.
    
    Returns:
    
    This builder for chaining.
  - getOrder
```
public Index.IndexField.Order getOrder()
```
```
 Indicates that this field supports ordering by the specified order or
 comparing using =, <, <=, >, >=.
 
```
    .google.firestore.admin.v1.Index.IndexField.Order order = 2;
    Specified by:
    
    getOrder in interface Index.IndexFieldOrBuilder
    
    Returns:
    
    The order.
  - setOrder
```
public Index.IndexField.Builder setOrder(Index.IndexField.Order value)
```
```
 Indicates that this field supports ordering by the specified order or
 comparing using =, <, <=, >, >=.
 
```
    .google.firestore.admin.v1.Index.IndexField.Order order = 2;
    Parameters:
    
    value - The order to set.
    
    Returns:
    
    This builder for chaining.
  - clearOrder
```
public Index.IndexField.Builder clearOrder()
```
```
 Indicates that this field supports ordering by the specified order or
 comparing using =, <, <=, >, >=.
 
```
    .google.firestore.admin.v1.Index.IndexField.Order order = 2;
    Returns:
    
    This builder for chaining.
  - getArrayConfigValue
```
public int getArrayConfigValue()
```
```
 Indicates that this field supports operations on `array_value`s.
 
```
    .google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
    Specified by:
    
    getArrayConfigValue in interface Index.IndexFieldOrBuilder
    
    Returns:
    
    The enum numeric value on the wire for arrayConfig.
  - setArrayConfigValue
```
public Index.IndexField.Builder setArrayConfigValue(int value)
```
```
 Indicates that this field supports operations on `array_value`s.
 
```
    .google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
    Parameters:
    
    value - The enum numeric value on the wire for arrayConfig to set.
    
    Returns:
    
    This builder for chaining.
  - getArrayConfig
```
public Index.IndexField.ArrayConfig getArrayConfig()
```
```
 Indicates that this field supports operations on `array_value`s.
 
```
    .google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
    Specified by:
    
    getArrayConfig in interface Index.IndexFieldOrBuilder
    
    Returns:
    
    The arrayConfig.
  - setArrayConfig
```
public Index.IndexField.Builder setArrayConfig(Index.IndexField.ArrayConfig value)
```
```
 Indicates that this field supports operations on `array_value`s.
 
```
    .google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
    Parameters:
    
    value - The arrayConfig to set.
    
    Returns:
    
    This builder for chaining.
  - clearArrayConfig
```
public Index.IndexField.Builder clearArrayConfig()
```
```
 Indicates that this field supports operations on `array_value`s.
 
```
    .google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
    Returns:
    
    This builder for chaining.
  - setUnknownFields
```
public final Index.IndexField.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<Index.IndexField.Builder>
  - mergeUnknownFields
```
public final Index.IndexField.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<Index.IndexField.Builder>

Class Index.IndexField.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.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getValueModeCase

clearValueMode

getFieldPath

getFieldPathBytes

setFieldPath

clearFieldPath

setFieldPathBytes

getOrderValue

setOrderValue

getOrder

setOrder

clearOrder

getArrayConfigValue

setArrayConfigValue

getArrayConfig

setArrayConfig

clearArrayConfig

setUnknownFields

mergeUnknownFields