Package com.google.firestore.admin.v1

Class Field.IndexConfig.Builder

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

  • 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.Builder<Field.IndexConfig.Builder>

    • clear

      public Field.IndexConfig.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.GeneratedMessage.Builder<Field.IndexConfig.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.GeneratedMessage.Builder<Field.IndexConfig.Builder>

    • getDefaultInstanceForType

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

    • build

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

    • buildPartial

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

    • mergeFrom

      public Field.IndexConfig.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<Field.IndexConfig.Builder>

    • mergeFrom

      public Field.IndexConfig.Builder mergeFrom(Field.IndexConfig other)

    • isInitialized

      public final boolean isInitialized()
      Specified by:
      isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
      Overrides:
      isInitialized in class com.google.protobuf.GeneratedMessage.Builder<Field.IndexConfig.Builder>

    • mergeFrom

      public Field.IndexConfig.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<Field.IndexConfig.Builder>
      Throws:
      IOException

    • 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

    • 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

    • setIndexes

      public Field.IndexConfig.Builder setIndexes(int index, Index value)
       The indexes supported for this field.
      repeated .google.firestore.admin.v1.Index indexes = 1;

    • setIndexes

      public Field.IndexConfig.Builder setIndexes(int index, Index.Builder builderForValue)
       The indexes supported for this field.
      repeated .google.firestore.admin.v1.Index indexes = 1;

    • addIndexes

      public Field.IndexConfig.Builder addIndexes(Index value)
       The indexes supported for this field.
      repeated .google.firestore.admin.v1.Index indexes = 1;

    • addIndexes

      public Field.IndexConfig.Builder addIndexes(int index, Index value)
       The indexes supported for this field.
      repeated .google.firestore.admin.v1.Index indexes = 1;

    • addIndexes

      public Field.IndexConfig.Builder addIndexes(Index.Builder builderForValue)
       The indexes supported for this field.
      repeated .google.firestore.admin.v1.Index indexes = 1;

    • addIndexes

      public Field.IndexConfig.Builder addIndexes(int index, Index.Builder builderForValue)
       The indexes supported for this field.
      repeated .google.firestore.admin.v1.Index indexes = 1;

    • addAllIndexes

      public Field.IndexConfig.Builder addAllIndexes(Iterable<? extends Index> values)
       The indexes supported for this field.
      repeated .google.firestore.admin.v1.Index indexes = 1;

    • clearIndexes

      public Field.IndexConfig.Builder clearIndexes()
       The indexes supported for this field.
      repeated .google.firestore.admin.v1.Index indexes = 1;

    • removeIndexes

      public Field.IndexConfig.Builder removeIndexes(int index)
       The indexes supported for this field.
      repeated .google.firestore.admin.v1.Index indexes = 1;

    • getIndexesBuilder

      public Index.Builder getIndexesBuilder(int index)
       The indexes supported for this field.
      repeated .google.firestore.admin.v1.Index indexes = 1;

    • 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

    • 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

    • addIndexesBuilder

      public Index.Builder addIndexesBuilder()
       The indexes supported for this field.
      repeated .google.firestore.admin.v1.Index indexes = 1;

    • addIndexesBuilder

      public Index.Builder addIndexesBuilder(int index)
       The indexes supported for this field.
      repeated .google.firestore.admin.v1.Index indexes = 1;

    • getIndexesBuilderList

      public List<Index.Builder> getIndexesBuilderList()
       The indexes supported for this field.
      repeated .google.firestore.admin.v1.Index indexes = 1;

    • 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.

    • setUsesAncestorConfig

      public Field.IndexConfig.Builder setUsesAncestorConfig(boolean value)
       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;
      Parameters:
      value - The usesAncestorConfig to set.
      Returns:
      This builder for chaining.

    • clearUsesAncestorConfig

      public Field.IndexConfig.Builder clearUsesAncestorConfig()
       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;
      Returns:
      This builder for chaining.

    • 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.

    • setAncestorField

      public Field.IndexConfig.Builder setAncestorField(String value)
       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;
      Parameters:
      value - The ancestorField to set.
      Returns:
      This builder for chaining.

    • clearAncestorField

      public Field.IndexConfig.Builder clearAncestorField()
       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;
      Returns:
      This builder for chaining.

    • setAncestorFieldBytes

      public Field.IndexConfig.Builder setAncestorFieldBytes(com.google.protobuf.ByteString value)
       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;
      Parameters:
      value - The bytes for ancestorField to set.
      Returns:
      This builder for chaining.

    • 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.

    • setReverting

      public Field.IndexConfig.Builder setReverting(boolean value)
       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;
      Parameters:
      value - The reverting to set.
      Returns:
      This builder for chaining.

    • clearReverting

      public Field.IndexConfig.Builder clearReverting()
       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;
      Returns:
      This builder for chaining.