public static final class Index.IndexField.Builder extends GeneratedMessageV3.Builder<Index.IndexField.Builder> implements Index.IndexFieldOrBuilderA 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
Inheritance
Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Index.IndexField.BuilderImplements
Index.IndexFieldOrBuilderStatic Methods
getDescriptor()
public static final Descriptors.Descriptor getDescriptor()| Type | Description |
| Descriptor |
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Index.IndexField.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| Index.IndexField.Builder |
build()
public Index.IndexField build()| Type | Description |
| Index.IndexField |
buildPartial()
public Index.IndexField buildPartial()| Type | Description |
| Index.IndexField |
clear()
public Index.IndexField.Builder clear()| Type | Description |
| Index.IndexField.Builder |
clearArrayConfig()
public Index.IndexField.Builder clearArrayConfig() Indicates that this field supports operations on array_values.
.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
| Type | Description |
| Index.IndexField.Builder | This builder for chaining. |
clearField(Descriptors.FieldDescriptor field)
public Index.IndexField.Builder clearField(Descriptors.FieldDescriptor field)| Name | Description |
| field | FieldDescriptor |
| Type | Description |
| Index.IndexField.Builder |
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;
| Type | Description |
| Index.IndexField.Builder | This builder for chaining. |
clearOneof(Descriptors.OneofDescriptor oneof)
public Index.IndexField.Builder clearOneof(Descriptors.OneofDescriptor oneof)| Name | Description |
| oneof | OneofDescriptor |
| Type | Description |
| Index.IndexField.Builder |
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;
| Type | Description |
| Index.IndexField.Builder | This builder for chaining. |
clearValueMode()
public Index.IndexField.Builder clearValueMode()| Type | Description |
| Index.IndexField.Builder |
clone()
public Index.IndexField.Builder clone()| Type | Description |
| Index.IndexField.Builder |
getArrayConfig()
public Index.IndexField.ArrayConfig getArrayConfig() Indicates that this field supports operations on array_values.
.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
| Type | Description |
| Index.IndexField.ArrayConfig | The arrayConfig. |
getArrayConfigValue()
public int getArrayConfigValue() Indicates that this field supports operations on array_values.
.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
| Type | Description |
| int | The enum numeric value on the wire for arrayConfig. |
getDefaultInstanceForType()
public Index.IndexField getDefaultInstanceForType()| Type | Description |
| Index.IndexField |
getDescriptorForType()
public Descriptors.Descriptor getDescriptorForType()| Type | Description |
| Descriptor |
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;
| Type | Description |
| String | The fieldPath. |
getFieldPathBytes()
public 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;
| Type | Description |
| ByteString | The bytes for fieldPath. |
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;
| Type | Description |
| Index.IndexField.Order | The order. |
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;
| Type | Description |
| int | The enum numeric value on the wire for order. |
getValueModeCase()
public Index.IndexField.ValueModeCase getValueModeCase()| Type | Description |
| Index.IndexField.ValueModeCase |
hasArrayConfig()
public boolean hasArrayConfig() Indicates that this field supports operations on array_values.
.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
| Type | Description |
| boolean | Whether the arrayConfig field is set. |
hasOrder()
public boolean hasOrder()Indicates that this field supports ordering by the specified order or comparing using =, !=, <, <=, >, >=.
.google.firestore.admin.v1.Index.IndexField.Order order = 2;
| Type | Description |
| boolean | Whether the order field is set. |
internalGetFieldAccessorTable()
protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()| Type | Description |
| FieldAccessorTable |
isInitialized()
public final boolean isInitialized()| Type | Description |
| boolean |
mergeFrom(Index.IndexField other)
public Index.IndexField.Builder mergeFrom(Index.IndexField other)| Name | Description |
| other | Index.IndexField |
| Type | Description |
| Index.IndexField.Builder |
mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
public Index.IndexField.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)| Name | Description |
| input | CodedInputStream |
| extensionRegistry | ExtensionRegistryLite |
| Type | Description |
| Index.IndexField.Builder |
| Type | Description |
| IOException |
mergeFrom(Message other)
public Index.IndexField.Builder mergeFrom(Message other)| Name | Description |
| other | Message |
| Type | Description |
| Index.IndexField.Builder |
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Index.IndexField.Builder mergeUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| Index.IndexField.Builder |
setArrayConfig(Index.IndexField.ArrayConfig value)
public Index.IndexField.Builder setArrayConfig(Index.IndexField.ArrayConfig value) Indicates that this field supports operations on array_values.
.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
| Name | Description |
| value | Index.IndexField.ArrayConfigThe arrayConfig to set. |
| Type | Description |
| Index.IndexField.Builder | This builder for chaining. |
setArrayConfigValue(int value)
public Index.IndexField.Builder setArrayConfigValue(int value) Indicates that this field supports operations on array_values.
.google.firestore.admin.v1.Index.IndexField.ArrayConfig array_config = 3;
| Name | Description |
| value | intThe enum numeric value on the wire for arrayConfig to set. |
| Type | Description |
| Index.IndexField.Builder | This builder for chaining. |
setField(Descriptors.FieldDescriptor field, Object value)
public Index.IndexField.Builder setField(Descriptors.FieldDescriptor field, Object value)| Name | Description |
| field | FieldDescriptor |
| value | Object |
| Type | Description |
| Index.IndexField.Builder |
setFieldPath(String value)
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;
| Name | Description |
| value | StringThe fieldPath to set. |
| Type | Description |
| Index.IndexField.Builder | This builder for chaining. |
setFieldPathBytes(ByteString value)
public Index.IndexField.Builder setFieldPathBytes(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;
| Name | Description |
| value | ByteStringThe bytes for fieldPath to set. |
| Type | Description |
| Index.IndexField.Builder | This builder for chaining. |
setOrder(Index.IndexField.Order value)
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;
| Name | Description |
| value | Index.IndexField.OrderThe order to set. |
| Type | Description |
| Index.IndexField.Builder | This builder for chaining. |
setOrderValue(int value)
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;
| Name | Description |
| value | intThe enum numeric value on the wire for order to set. |
| Type | Description |
| Index.IndexField.Builder | This builder for chaining. |
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Index.IndexField.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)| Name | Description |
| field | FieldDescriptor |
| index | int |
| value | Object |
| Type | Description |
| Index.IndexField.Builder |
setUnknownFields(UnknownFieldSet unknownFields)
public final Index.IndexField.Builder setUnknownFields(UnknownFieldSet unknownFields)| Name | Description |
| unknownFields | UnknownFieldSet |
| Type | Description |
| Index.IndexField.Builder |