Package com.google.firestore.admin.v1

Class Field

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.firestore.admin.v1.Field
All Implemented Interfaces:
FieldOrBuilder, com.google.protobuf.Message, com.google.protobuf.MessageLite, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Serializable
@Generated public final class Field extends com.google.protobuf.GeneratedMessage implements FieldOrBuilder
 Represents a single field in the database.

 Fields are grouped by their "Collection Group", which represent all
 collections in the database with the same ID.
Protobuf type google.firestore.admin.v1.Field
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Field.Builder
    Represents a single field in the database.
    static final class 
    Field.IndexConfig
    The index configuration for this field.
    static interface 
    Field.IndexConfigOrBuilder
     
    static final class 
    Field.TtlConfig
    The TTL (time-to-live) configuration for documents that have this `Field` set.
    static interface 
    Field.TtlConfigOrBuilder
     

    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
    INDEX_CONFIG_FIELD_NUMBER
     
    static final int
    NAME_FIELD_NUMBER
     
    static final int
    TTL_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)
     
    static Field
    getDefaultInstance()
     
    Field
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    Field.IndexConfig
    getIndexConfig()
    The index configuration for this field.
    Field.IndexConfigOrBuilder
    getIndexConfigOrBuilder()
    The index configuration for this field.
    String
    getName()
    Required.
    com.google.protobuf.ByteString
    getNameBytes()
    Required.
    com.google.protobuf.Parser<Field>
    getParserForType()
     
    int
    getSerializedSize()
     
    Field.TtlConfig
    getTtlConfig()
    The TTL configuration for this `Field`.
    Field.TtlConfigOrBuilder
    getTtlConfigOrBuilder()
    The TTL configuration for this `Field`.
    int
    hashCode()
     
    boolean
    hasIndexConfig()
    The index configuration for this field.
    boolean
    hasTtlConfig()
    The TTL configuration for this `Field`.
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Field.Builder
    newBuilder()
     
    static Field.Builder
    newBuilder(Field prototype)
     
    Field.Builder
    newBuilderForType()
     
    protected Field.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Field
    parseDelimitedFrom(InputStream input)
     
    static Field
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Field
    parseFrom(byte[] data)
     
    static Field
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Field
    parseFrom(com.google.protobuf.ByteString data)
     
    static Field
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Field
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Field
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Field
    parseFrom(InputStream input)
     
    static Field
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Field
    parseFrom(ByteBuffer data)
     
    static Field
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Field>
    parser()
     
    Field.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

  • 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

    • getName

      public String getName()
       Required. A field name of the form:
 `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`

 A field path can be a simple field name, e.g. `address` or a path to fields
 within `map_value` , e.g. `address.city`,
 or a special field path. The only valid special field is `*`, which
 represents any field.

 Field paths can be quoted using `` ` `` (backtick). The only character that
 must be escaped within a quoted field path is the backtick character
 itself, escaped using a backslash. Special characters in field paths that
 must be quoted include: `*`, `.`,
 `` ` `` (backtick), `[`, `]`, as well as any ascii symbolic characters.

 Examples:
 `` `address.city` `` represents a field named `address.city`, not the map
 key `city` in the field `address`. `` `*` `` represents a field named `*`,
 not any field.

 A special `Field` contains the default indexing settings for all fields.
 This field's resource name is:
 `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`
 Indexes defined on this `Field` will be applied to all fields which do not
 have their own `Field` index configuration.
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getName in interface FieldOrBuilder
      Returns:
      The name.

    • getNameBytes

      public com.google.protobuf.ByteString getNameBytes()
       Required. A field name of the form:
 `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}`

 A field path can be a simple field name, e.g. `address` or a path to fields
 within `map_value` , e.g. `address.city`,
 or a special field path. The only valid special field is `*`, which
 represents any field.

 Field paths can be quoted using `` ` `` (backtick). The only character that
 must be escaped within a quoted field path is the backtick character
 itself, escaped using a backslash. Special characters in field paths that
 must be quoted include: `*`, `.`,
 `` ` `` (backtick), `[`, `]`, as well as any ascii symbolic characters.

 Examples:
 `` `address.city` `` represents a field named `address.city`, not the map
 key `city` in the field `address`. `` `*` `` represents a field named `*`,
 not any field.

 A special `Field` contains the default indexing settings for all fields.
 This field's resource name is:
 `projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*`
 Indexes defined on this `Field` will be applied to all fields which do not
 have their own `Field` index configuration.
      string name = 1 [(.google.api.field_behavior) = REQUIRED];
      Specified by:
      getNameBytes in interface FieldOrBuilder
      Returns:
      The bytes for name.

    • hasIndexConfig

      public boolean hasIndexConfig()
       The index configuration for this field. If unset, field indexing will
 revert to the configuration defined by the `ancestor_field`. To
 explicitly remove all indexes for this field, specify an index config
 with an empty list of indexes.
      .google.firestore.admin.v1.Field.IndexConfig index_config = 2;
      Specified by:
      hasIndexConfig in interface FieldOrBuilder
      Returns:
      Whether the indexConfig field is set.

    • getIndexConfig

      public Field.IndexConfig getIndexConfig()
       The index configuration for this field. If unset, field indexing will
 revert to the configuration defined by the `ancestor_field`. To
 explicitly remove all indexes for this field, specify an index config
 with an empty list of indexes.
      .google.firestore.admin.v1.Field.IndexConfig index_config = 2;
      Specified by:
      getIndexConfig in interface FieldOrBuilder
      Returns:
      The indexConfig.

    • getIndexConfigOrBuilder

      public Field.IndexConfigOrBuilder getIndexConfigOrBuilder()
       The index configuration for this field. If unset, field indexing will
 revert to the configuration defined by the `ancestor_field`. To
 explicitly remove all indexes for this field, specify an index config
 with an empty list of indexes.
      .google.firestore.admin.v1.Field.IndexConfig index_config = 2;
      Specified by:
      getIndexConfigOrBuilder in interface FieldOrBuilder

    • hasTtlConfig

      public boolean hasTtlConfig()
       The TTL configuration for this `Field`.
 Setting or unsetting this will enable or disable the TTL for
 documents that have this `Field`.
      .google.firestore.admin.v1.Field.TtlConfig ttl_config = 3;
      Specified by:
      hasTtlConfig in interface FieldOrBuilder
      Returns:
      Whether the ttlConfig field is set.

    • getTtlConfig

      public Field.TtlConfig getTtlConfig()
       The TTL configuration for this `Field`.
 Setting or unsetting this will enable or disable the TTL for
 documents that have this `Field`.
      .google.firestore.admin.v1.Field.TtlConfig ttl_config = 3;
      Specified by:
      getTtlConfig in interface FieldOrBuilder
      Returns:
      The ttlConfig.

    • getTtlConfigOrBuilder

      public Field.TtlConfigOrBuilder getTtlConfigOrBuilder()
       The TTL configuration for this `Field`.
 Setting or unsetting this will enable or disable the TTL for
 documents that have this `Field`.
      .google.firestore.admin.v1.Field.TtlConfig ttl_config = 3;
      Specified by:
      getTtlConfigOrBuilder in interface FieldOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

      public static Field 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 parseFrom(byte[] data) throws com.google.protobuf.InvalidProtocolBufferException
      Throws:
      com.google.protobuf.InvalidProtocolBufferException

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Field.Builder newBuilder()

    • newBuilder

      public static Field.Builder newBuilder(Field prototype)

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Field getDefaultInstance()

    • parser

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

    • getParserForType

      public com.google.protobuf.Parser<Field> 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 getDefaultInstanceForType()
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
      Specified by:
      getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder