Class Field.TtlConfig.Builder (3.15.7)
Version 3.15.7keyboard_arrow_down
public static final class Field . TtlConfig . Builder extends GeneratedMessageV3 . Builder<Field . TtlConfig . Builder > implements Field . TtlConfigOrBuilder
The TTL (time-to-live) configuration for documents that have this Field
set.
Storing a timestamp value into a TTL-enabled field will be treated as
the document's absolute expiration time. Using any other data type or
leaving the field absent will disable the TTL for the individual document.
Protobuf type google.firestore.admin.v1.Field.TtlConfig
Inherited Members
com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.internalGetMutableMapFieldReflection(int)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)
com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)
com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)
com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)
Static Methods
getDescriptor()
public static final Descriptors . Descriptor getDescriptor ()
Methods
addRepeatedField(Descriptors.FieldDescriptor field, Object value)
public Field . TtlConfig . Builder addRepeatedField ( Descriptors . FieldDescriptor field , Object value )
Overrides
build()
public Field . TtlConfig build ()
buildPartial()
public Field . TtlConfig buildPartial ()
clear()
public Field . TtlConfig . Builder clear ()
Overrides
clearField(Descriptors.FieldDescriptor field)
public Field . TtlConfig . Builder clearField ( Descriptors . FieldDescriptor field )
Overrides
clearOneof(Descriptors.OneofDescriptor oneof)
public Field . TtlConfig . Builder clearOneof ( Descriptors . OneofDescriptor oneof )
Overrides
clearState()
public Field . TtlConfig . Builder clearState ()
Output only. The state of the TTL configuration.
.google.firestore.admin.v1.Field.TtlConfig.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
clone()
public Field . TtlConfig . Builder clone ()
Overrides
getDefaultInstanceForType()
public Field . TtlConfig getDefaultInstanceForType ()
getDescriptorForType()
public Descriptors . Descriptor getDescriptorForType ()
Overrides
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];
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];
Returns
Type Description
int The enum numeric value on the wire for state.
internalGetFieldAccessorTable()
protected GeneratedMessageV3 . FieldAccessorTable internalGetFieldAccessorTable ()
Overrides
isInitialized()
public final boolean isInitialized ()
Overrides
mergeFrom(Field.TtlConfig other)
public Field . TtlConfig . Builder mergeFrom ( Field . TtlConfig other )
public Field . TtlConfig . Builder mergeFrom ( CodedInputStream input , ExtensionRegistryLite extensionRegistry )
Overrides
mergeFrom(Message other)
public Field . TtlConfig . Builder mergeFrom ( Message other )
Parameter
Name Description
otherMessage
Overrides
mergeUnknownFields(UnknownFieldSet unknownFields)
public final Field . TtlConfig . Builder mergeUnknownFields ( UnknownFieldSet unknownFields )
Overrides
setField(Descriptors.FieldDescriptor field, Object value)
public Field . TtlConfig . Builder setField ( Descriptors . FieldDescriptor field , Object value )
Overrides
setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
public Field . TtlConfig . Builder setRepeatedField ( Descriptors . FieldDescriptor field , int index , Object value )
Overrides
setState(Field.TtlConfig.State value)
public Field . TtlConfig . Builder setState ( Field . TtlConfig . State value )
Output only. The state of the TTL configuration.
.google.firestore.admin.v1.Field.TtlConfig.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
setStateValue(int value)
public Field . TtlConfig . Builder setStateValue ( int value )
Output only. The state of the TTL configuration.
.google.firestore.admin.v1.Field.TtlConfig.State state = 1 [(.google.api.field_behavior) = OUTPUT_ONLY];
Parameter
Name Description
valueint The enum numeric value on the wire for state to set.
setUnknownFields(UnknownFieldSet unknownFields)
public final Field . TtlConfig . Builder setUnknownFields ( UnknownFieldSet unknownFields )
Overrides
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License , and code samples are licensed under the Apache 2.0 License . For details, see the Google Developers Site Policies . Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2025-10-29 UTC.
[[["Easy to understand","easyToUnderstand","thumb-up"],["Solved my problem","solvedMyProblem","thumb-up"],["Other","otherUp","thumb-up"]],[["Missing the information I need","missingTheInformationINeed","thumb-down"],["Too complicated / too many steps","tooComplicatedTooManySteps","thumb-down"],["Out of date","outOfDate","thumb-down"],["Samples / code issue","samplesCodeIssue","thumb-down"],["Other","otherDown","thumb-down"]],["Last updated 2025-10-29 UTC."],[],[]]
