Package com.google.firestore.admin.v1

Class Field.IndexConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.firestore.admin.v1.Field.IndexConfig
All Implemented Interfaces:
Field.IndexConfigOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
Enclosing class:
Field
public static final class Field.IndexConfig extends com.google.protobuf.GeneratedMessage implements Field.IndexConfigOrBuilder
 The index configuration for this field.
Protobuf type google.firestore.admin.v1.Field.IndexConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Field.IndexConfig.Builder
    The index configuration for this field.

    Nested classes/interfaces inherited from class com.google.protobuf.GeneratedMessage

    com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>,BuilderT extends com.google.protobuf.GeneratedMessage.ExtendableBuilder<MessageT,BuilderT>>, com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.ExtendableMessageOrBuilder<MessageT extends com.google.protobuf.GeneratedMessage.ExtendableMessage<MessageT>>, com.google.protobuf.GeneratedMessage.FieldAccessorTable, com.google.protobuf.GeneratedMessage.GeneratedExtension<ContainingT extends com.google.protobuf.Message,T extends Object>, com.google.protobuf.GeneratedMessage.UnusedPrivateParameter

    Nested classes/interfaces inherited from class com.google.protobuf.AbstractMessage

    com.google.protobuf.AbstractMessage.BuilderParent

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

    com.google.protobuf.AbstractMessageLite.InternalOneOfEnum

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final int
    ANCESTOR_FIELD_FIELD_NUMBER
     
    static final int
    INDEXES_FIELD_NUMBER
     
    static final int
    REVERTING_FIELD_NUMBER
     
    static final int
    USES_ANCESTOR_CONFIG_FIELD_NUMBER
     

    Fields inherited from class com.google.protobuf.GeneratedMessage

    alwaysUseFieldBuilders, loggedPre22TypeNames, unknownFields

    Fields inherited from class com.google.protobuf.AbstractMessage

    memoizedSize

    Fields inherited from class com.google.protobuf.AbstractMessageLite

    memoizedHashCode

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    equals(Object obj)
     
    String
    getAncestorField()
    Output only.
    com.google.protobuf.ByteString
    getAncestorFieldBytes()
    Output only.
    static Field.IndexConfig
    getDefaultInstance()
     
    Field.IndexConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Index
    getIndexes(int index)
    The indexes supported for this field.
    int
    getIndexesCount()
    The indexes supported for this field.
    List<Index>
    getIndexesList()
    The indexes supported for this field.
    IndexOrBuilder
    getIndexesOrBuilder(int index)
    The indexes supported for this field.
    List<? extends IndexOrBuilder>
    getIndexesOrBuilderList()
    The indexes supported for this field.
    com.google.protobuf.Parser<Field.IndexConfig>
    getParserForType()
     
    boolean
    getReverting()
    Output only When true, the `Field`'s index configuration is in the process of being reverted.
    int
    getSerializedSize()
     
    boolean
    getUsesAncestorConfig()
    Output only.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Field.IndexConfig.Builder
    newBuilder()
     
    static Field.IndexConfig.Builder
    newBuilder(Field.IndexConfig prototype)
     
    Field.IndexConfig.Builder
    newBuilderForType()
     
    protected Field.IndexConfig.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Field.IndexConfig
    parseDelimitedFrom(InputStream input)
     
    static Field.IndexConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Field.IndexConfig
    parseFrom(byte[] data)
     
    static Field.IndexConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Field.IndexConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static Field.IndexConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Field.IndexConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Field.IndexConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Field.IndexConfig
    parseFrom(InputStream input)
     
    static Field.IndexConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Field.IndexConfig
    parseFrom(ByteBuffer data)
     
    static Field.IndexConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Field.IndexConfig>
    parser()
     
    Field.IndexConfig.Builder
    toBuilder()
     
    void
    writeTo(com.google.protobuf.CodedOutputStream output)
     

    Methods inherited from class com.google.protobuf.GeneratedMessage

    canUseUnsafe, computeStringSize, computeStringSizeNoTag, emptyBooleanList, emptyDoubleList, emptyFloatList, emptyIntList, emptyList, emptyLongList, getAllFields, getDescriptorForType, getField, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof, internalGetMapField, internalGetMapFieldReflection, isStringEmpty, makeExtensionsImmutable, makeMutableCopy, makeMutableCopy, mergeFromAndMakeImmutableInternal, newFileScopedGeneratedExtension, newInstance, newMessageScopedGeneratedExtension, parseDelimitedWithIOException, parseDelimitedWithIOException, parseUnknownField, parseUnknownFieldProto3, parseWithIOException, parseWithIOException, parseWithIOException, parseWithIOException, serializeBooleanMapTo, serializeIntegerMapTo, serializeLongMapTo, serializeStringMapTo, writeReplace, writeString, writeStringNoTag

    Methods inherited from class com.google.protobuf.AbstractMessage

    findInitializationErrors, getInitializationErrorString, hashFields, toString

    Methods inherited from class com.google.protobuf.AbstractMessageLite

    addAll, checkByteStringIsUtf8, toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

    Methods inherited from interface com.google.protobuf.MessageLite

    toByteArray, toByteString, writeDelimitedTo, writeTo

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Field Details

    • INDEXES_FIELD_NUMBER

      public static final int INDEXES_FIELD_NUMBER
      See Also:

    • USES_ANCESTOR_CONFIG_FIELD_NUMBER

      public static final int USES_ANCESTOR_CONFIG_FIELD_NUMBER
      See Also:

    • ANCESTOR_FIELD_FIELD_NUMBER

      public static final int ANCESTOR_FIELD_FIELD_NUMBER
      See Also:

    • REVERTING_FIELD_NUMBER

      public static final int REVERTING_FIELD_NUMBER
      See Also:

  • Method Details

    • getDescriptor

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

    • internalGetFieldAccessorTable

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

    • getIndexesList

      public List<Index> getIndexesList()
       The indexes supported for this field.
      repeated .google.firestore.admin.v1.Index indexes = 1;
      Specified by:
      getIndexesList in interface Field.IndexConfigOrBuilder

    • getIndexesOrBuilderList

      public List<? extends IndexOrBuilder> getIndexesOrBuilderList()
       The indexes supported for this field.
      repeated .google.firestore.admin.v1.Index indexes = 1;
      Specified by:
      getIndexesOrBuilderList in interface Field.IndexConfigOrBuilder

    • getIndexesCount

      public int getIndexesCount()
       The indexes supported for this field.
      repeated .google.firestore.admin.v1.Index indexes = 1;
      Specified by:
      getIndexesCount in interface Field.IndexConfigOrBuilder

    • getIndexes

      public Index getIndexes(int index)
       The indexes supported for this field.
      repeated .google.firestore.admin.v1.Index indexes = 1;
      Specified by:
      getIndexes in interface Field.IndexConfigOrBuilder

    • getIndexesOrBuilder

      public IndexOrBuilder getIndexesOrBuilder(int index)
       The indexes supported for this field.
      repeated .google.firestore.admin.v1.Index indexes = 1;
      Specified by:
      getIndexesOrBuilder in interface Field.IndexConfigOrBuilder

    • getUsesAncestorConfig

      public boolean getUsesAncestorConfig()
       Output only. When true, the `Field`'s index configuration is set from the
 configuration specified by the `ancestor_field`.
 When false, the `Field`'s index configuration is defined explicitly.
      bool uses_ancestor_config = 2;
      Specified by:
      getUsesAncestorConfig in interface Field.IndexConfigOrBuilder
      Returns:
      The usesAncestorConfig.

    • getAncestorField

      public String getAncestorField()
       Output only. Specifies the resource name of the `Field` from which this
 field's index configuration is set (when `uses_ancestor_config` is true),
 or from which it *would* be set if this field had no index configuration
 (when `uses_ancestor_config` is false).
      string ancestor_field = 3;
      Specified by:
      getAncestorField in interface Field.IndexConfigOrBuilder
      Returns:
      The ancestorField.

    • getAncestorFieldBytes

      public com.google.protobuf.ByteString getAncestorFieldBytes()
       Output only. Specifies the resource name of the `Field` from which this
 field's index configuration is set (when `uses_ancestor_config` is true),
 or from which it *would* be set if this field had no index configuration
 (when `uses_ancestor_config` is false).
      string ancestor_field = 3;
      Specified by:
      getAncestorFieldBytes in interface Field.IndexConfigOrBuilder
      Returns:
      The bytes for ancestorField.

    • getReverting

      public boolean getReverting()
       Output only
 When true, the `Field`'s index configuration is in the process of being
 reverted. Once complete, the index config will transition to the same
 state as the field specified by `ancestor_field`, at which point
 `uses_ancestor_config` will be `true` and `reverting` will be `false`.
      bool reverting = 4;
      Specified by:
      getReverting in interface Field.IndexConfigOrBuilder
      Returns:
      The reverting.

    • isInitialized

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

    • 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.GeneratedMessage
      Throws:
      IOException

    • getSerializedSize

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

    • 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 Field.IndexConfig parseFrom(ByteBuffer data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

      public static Field.IndexConfig parseFrom(com.google.protobuf.ByteString data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Field.IndexConfig parseFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Field.IndexConfig parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Field.IndexConfig parseDelimitedFrom(InputStream input) throws IOException
      Throws:
      IOException

    • parseDelimitedFrom

      public static Field.IndexConfig parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry) throws IOException
      Throws:
      IOException

    • parseFrom

      public static Field.IndexConfig parseFrom(com.google.protobuf.CodedInputStream input) throws IOException
      Throws:
      IOException

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Field.IndexConfig.Builder newBuilder()

    • newBuilder

      public static Field.IndexConfig.Builder newBuilder(Field.IndexConfig prototype)

    • toBuilder

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

    • newBuilderForType

      protected Field.IndexConfig.Builder newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
      Overrides:
      newBuilderForType in class com.google.protobuf.AbstractMessage

    • getDefaultInstance

      public static Field.IndexConfig getDefaultInstance()

    • parser

      public static com.google.protobuf.Parser<Field.IndexConfig> parser()

    • getParserForType

      public com.google.protobuf.Parser<Field.IndexConfig> 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.GeneratedMessage

    • getDefaultInstanceForType

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