Package com.google.firestore.admin.v1

Class Field.TtlConfig

java.lang.Object
com.google.protobuf.AbstractMessageLite
com.google.protobuf.AbstractMessage
com.google.protobuf.GeneratedMessage
com.google.firestore.admin.v1.Field.TtlConfig
All Implemented Interfaces:
Field.TtlConfigOrBuilder, 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.TtlConfig extends com.google.protobuf.GeneratedMessage implements Field.TtlConfigOrBuilder
 The TTL (time-to-live) configuration for documents that have this `Field`
 set.

 A timestamp stored in a TTL-enabled field will be used to determine the
 expiration time of the document. The expiration time is the sum
 of the timestamp value and the `expiration_offset`.

 For Enterprise edition databases, the timestamp value may alternatively be
 stored in an array value in the TTL-enabled field.

 An expiration time in the past indicates that the document is eligible for
 immediate expiration. Using any other data type or leaving the field absent
 will disable expiration for the individual document.
Protobuf type google.firestore.admin.v1.Field.TtlConfig
See Also:

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static final class 
    Field.TtlConfig.Builder
    The TTL (time-to-live) configuration for documents that have this `Field` set.
    static enum 
    Field.TtlConfig.State
    The state of applying the TTL configuration to all documents.

    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
    EXPIRATION_OFFSET_FIELD_NUMBER
     
    static final int
    STATE_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.TtlConfig
    getDefaultInstance()
     
    Field.TtlConfig
    getDefaultInstanceForType()
     
    static final com.google.protobuf.Descriptors.Descriptor
    getDescriptor()
     
    com.google.protobuf.Duration
    getExpirationOffset()
    Optional.
    com.google.protobuf.DurationOrBuilder
    getExpirationOffsetOrBuilder()
    Optional.
    com.google.protobuf.Parser<Field.TtlConfig>
    getParserForType()
     
    int
    getSerializedSize()
     
    Field.TtlConfig.State
    getState()
    Output only.
    int
    getStateValue()
    Output only.
    boolean
    hasExpirationOffset()
    Optional.
    int
    hashCode()
     
    protected com.google.protobuf.GeneratedMessage.FieldAccessorTable
    internalGetFieldAccessorTable()
     
    final boolean
    isInitialized()
     
    static Field.TtlConfig.Builder
    newBuilder()
     
    static Field.TtlConfig.Builder
    newBuilder(Field.TtlConfig prototype)
     
    Field.TtlConfig.Builder
    newBuilderForType()
     
    protected Field.TtlConfig.Builder
    newBuilderForType(com.google.protobuf.AbstractMessage.BuilderParent parent)
     
    static Field.TtlConfig
    parseDelimitedFrom(InputStream input)
     
    static Field.TtlConfig
    parseDelimitedFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Field.TtlConfig
    parseFrom(byte[] data)
     
    static Field.TtlConfig
    parseFrom(byte[] data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Field.TtlConfig
    parseFrom(com.google.protobuf.ByteString data)
     
    static Field.TtlConfig
    parseFrom(com.google.protobuf.ByteString data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Field.TtlConfig
    parseFrom(com.google.protobuf.CodedInputStream input)
     
    static Field.TtlConfig
    parseFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Field.TtlConfig
    parseFrom(InputStream input)
     
    static Field.TtlConfig
    parseFrom(InputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static Field.TtlConfig
    parseFrom(ByteBuffer data)
     
    static Field.TtlConfig
    parseFrom(ByteBuffer data, com.google.protobuf.ExtensionRegistryLite extensionRegistry)
     
    static com.google.protobuf.Parser<Field.TtlConfig>
    parser()
     
    Field.TtlConfig.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

    • STATE_FIELD_NUMBER

      public static final int STATE_FIELD_NUMBER
      See Also:

    • EXPIRATION_OFFSET_FIELD_NUMBER

      public static final int EXPIRATION_OFFSET_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

    • getStateValue

      public int getStateValue()
       Output only. The state of the TTL configuration.
      .google.firestore.admin.v1.Field.TtlConfig.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getStateValue in interface Field.TtlConfigOrBuilder
      Returns:
      The enum numeric value on the wire for state.

    • getState

      public Field.TtlConfig.State getState()
       Output only. The state of the TTL configuration.
      .google.firestore.admin.v1.Field.TtlConfig.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
      Specified by:
      getState in interface Field.TtlConfigOrBuilder
      Returns:
      The state.

    • hasExpirationOffset

      public boolean hasExpirationOffset()
       Optional. The offset, relative to the timestamp value from the
 TTL-enabled field, used to determine the document's expiration time.

 `expiration_offset.seconds` must be between 0 and 2,147,483,647
 inclusive. Values more precise than seconds are rejected.

 If unset, defaults to 0, in which case the expiration time is the same
 as the timestamp value from the TTL-enabled field.
      .google.protobuf.Duration expiration_offset = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      hasExpirationOffset in interface Field.TtlConfigOrBuilder
      Returns:
      Whether the expirationOffset field is set.

    • getExpirationOffset

      public com.google.protobuf.Duration getExpirationOffset()
       Optional. The offset, relative to the timestamp value from the
 TTL-enabled field, used to determine the document's expiration time.

 `expiration_offset.seconds` must be between 0 and 2,147,483,647
 inclusive. Values more precise than seconds are rejected.

 If unset, defaults to 0, in which case the expiration time is the same
 as the timestamp value from the TTL-enabled field.
      .google.protobuf.Duration expiration_offset = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExpirationOffset in interface Field.TtlConfigOrBuilder
      Returns:
      The expirationOffset.

    • getExpirationOffsetOrBuilder

      public com.google.protobuf.DurationOrBuilder getExpirationOffsetOrBuilder()
       Optional. The offset, relative to the timestamp value from the
 TTL-enabled field, used to determine the document's expiration time.

 `expiration_offset.seconds` must be between 0 and 2,147,483,647
 inclusive. Values more precise than seconds are rejected.

 If unset, defaults to 0, in which case the expiration time is the same
 as the timestamp value from the TTL-enabled field.
      .google.protobuf.Duration expiration_offset = 3 [(.google.api.field_behavior) = OPTIONAL];
      Specified by:
      getExpirationOffsetOrBuilder in interface Field.TtlConfigOrBuilder

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseFrom

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

    • parseDelimitedFrom

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

    • parseDelimitedFrom

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

    • parseFrom

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

    • parseFrom

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

    • newBuilderForType

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

    • newBuilder

      public static Field.TtlConfig.Builder newBuilder()

    • newBuilder

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

    • toBuilder

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

    • newBuilderForType

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

    • getDefaultInstance

      public static Field.TtlConfig getDefaultInstance()

    • parser

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

    • getParserForType

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