Class Field.TtlConfig.Builder (3.13.2)

Version 3.13.2

• 3.28.0 (latest)
• 3.27.2
• 3.26.5
• 3.25.1
• 3.24.3
• 3.22.0
• 3.21.4
• 3.20.0
• 3.17.0
• 3.16.3
• 3.15.7
• 3.14.4
• 3.13.2
• 3.12.1
• 3.11.0
• 3.10.0
• 3.9.6
• 3.8.2
• 3.7.10
• 3.6.0
• 3.5.0
• 3.4.2
• 3.3.0
• 3.2.0
• 3.1.0
• 3.0.21

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

Inheritance

Object > AbstractMessageLite.Builder<MessageType,BuilderType> > AbstractMessage.Builder<BuilderType> > GeneratedMessageV3.Builder > Field.TtlConfig.Builder

Implements

Field.TtlConfigOrBuilder

Inherited Members

AbstractMessage.Builder.findInitializationErrors()

AbstractMessage.Builder.getInitializationErrorString()

AbstractMessage.Builder.internalMergeFrom(AbstractMessageLite)

AbstractMessage.Builder.mergeFrom(byte[])

AbstractMessage.Builder.mergeFrom(byte[],ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(byte[],int,int)

AbstractMessage.Builder.mergeFrom(byte[],int,int,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(ByteString)

AbstractMessage.Builder.mergeFrom(ByteString,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(CodedInputStream)

AbstractMessage.Builder.mergeFrom(CodedInputStream,ExtensionRegistryLite)

AbstractMessage.Builder.mergeFrom(Message)

AbstractMessage.Builder.mergeFrom(InputStream)

AbstractMessage.Builder.mergeFrom(InputStream,ExtensionRegistryLite)

AbstractMessage.Builder.newUninitializedMessageException(Message)

AbstractMessage.Builder.toString()

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,Collection<? super T>)

AbstractMessageLite.Builder.<T>addAll(Iterable<T>,List<? super T>)

AbstractMessageLite.Builder.internalMergeFrom(MessageType)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream)

AbstractMessageLite.Builder.mergeDelimitedFrom(InputStream,ExtensionRegistryLite)

AbstractMessageLite.Builder.mergeFrom(MessageLite)

AbstractMessageLite.Builder.newUninitializedMessageException(MessageLite)

GeneratedMessageV3.Builder.addRepeatedField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.clear()

GeneratedMessageV3.Builder.clearField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.clearOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.clone()

GeneratedMessageV3.Builder.getAllFields()

GeneratedMessageV3.Builder.getDescriptorForType()

GeneratedMessageV3.Builder.getField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getFieldBuilder(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.getOneofFieldDescriptor(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.getParentForChildren()

GeneratedMessageV3.Builder.getRepeatedField(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldBuilder(Descriptors.FieldDescriptor,int)

GeneratedMessageV3.Builder.getRepeatedFieldCount(Descriptors.FieldDescriptor)

com.google.protobuf.GeneratedMessageV3.Builder.getUnknownFieldSetBuilder()

GeneratedMessageV3.Builder.getUnknownFields()

GeneratedMessageV3.Builder.hasField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.hasOneof(Descriptors.OneofDescriptor)

GeneratedMessageV3.Builder.internalGetFieldAccessorTable()

GeneratedMessageV3.Builder.internalGetMapField(int)

GeneratedMessageV3.Builder.internalGetMutableMapField(int)

GeneratedMessageV3.Builder.isClean()

GeneratedMessageV3.Builder.isInitialized()

GeneratedMessageV3.Builder.markClean()

GeneratedMessageV3.Builder.mergeUnknownFields(UnknownFieldSet)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownLengthDelimitedField(int,com.google.protobuf.ByteString)

com.google.protobuf.GeneratedMessageV3.Builder.mergeUnknownVarintField(int,int)

GeneratedMessageV3.Builder.newBuilderForField(Descriptors.FieldDescriptor)

GeneratedMessageV3.Builder.onBuilt()

GeneratedMessageV3.Builder.onChanged()

com.google.protobuf.GeneratedMessageV3.Builder.parseUnknownField(com.google.protobuf.CodedInputStream,com.google.protobuf.ExtensionRegistryLite,int)

GeneratedMessageV3.Builder.setField(Descriptors.FieldDescriptor,Object)

GeneratedMessageV3.Builder.setRepeatedField(Descriptors.FieldDescriptor,int,Object)

com.google.protobuf.GeneratedMessageV3.Builder.setUnknownFieldSetBuilder(com.google.protobuf.UnknownFieldSet.Builder)

GeneratedMessageV3.Builder.setUnknownFields(UnknownFieldSet)

GeneratedMessageV3.Builder.setUnknownFieldsProto3(UnknownFieldSet)

Object.equals(Object)

Object.finalize()

Object.getClass()

Object.hashCode()

Object.notify()

Object.notifyAll()

Object.wait()

Object.wait(long)

Object.wait(long,int)

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()

Returns
Type	Description
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Field.TtlConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Field.TtlConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.addRepeatedField(Descriptors.FieldDescriptor field, Object value)

build()

public Field.TtlConfig build()

Returns
Type	Description
Field.TtlConfig

buildPartial()

public Field.TtlConfig buildPartial()

Returns
Type	Description
Field.TtlConfig

clear()

public Field.TtlConfig.Builder clear()

Returns
Type	Description
Field.TtlConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clear()

clearField(Descriptors.FieldDescriptor field)

public Field.TtlConfig.Builder clearField(Descriptors.FieldDescriptor field)

Parameter
Name	Description
field	FieldDescriptor

Returns
Type	Description
Field.TtlConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearField(Descriptors.FieldDescriptor field)

clearOneof(Descriptors.OneofDescriptor oneof)

public Field.TtlConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)

Parameter
Name	Description
oneof	OneofDescriptor

Returns
Type	Description
Field.TtlConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clearOneof(Descriptors.OneofDescriptor oneof)

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];

Returns
Type	Description
Field.TtlConfig.Builder	This builder for chaining.

clone()

public Field.TtlConfig.Builder clone()

Returns
Type	Description
Field.TtlConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.clone()

getDefaultInstanceForType()

public Field.TtlConfig getDefaultInstanceForType()

Returns
Type	Description
Field.TtlConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()

Returns
Type	Description
Descriptor

Overrides

GeneratedMessageV3.Builder<BuilderType>.getDescriptorForType()

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];

Returns
Type	Description
Field.TtlConfig.State	The state.

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()

Returns
Type	Description
FieldAccessorTable

Overrides

GeneratedMessageV3.Builder<BuilderType>.internalGetFieldAccessorTable()

isInitialized()

public final boolean isInitialized()

Returns
Type	Description
boolean

Overrides

GeneratedMessageV3.Builder<BuilderType>.isInitialized()

mergeFrom(Field.TtlConfig other)

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

Parameter
Name	Description
other	Field.TtlConfig

Returns
Type	Description
Field.TtlConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Field.TtlConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Parameters
Name	Description
input	CodedInputStream
extensionRegistry	ExtensionRegistryLite

Returns
Type	Description
Field.TtlConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

Exceptions
Type	Description
IOException

mergeFrom(Message other)

public Field.TtlConfig.Builder mergeFrom(Message other)

Parameter
Name	Description
other	Message

Returns
Type	Description
Field.TtlConfig.Builder

Overrides

AbstractMessage.Builder<BuilderType>.mergeFrom(Message other)

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Field.TtlConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Field.TtlConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.mergeUnknownFields(UnknownFieldSet unknownFields)

setField(Descriptors.FieldDescriptor field, Object value)

public Field.TtlConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)

Parameters
Name	Description
field	FieldDescriptor
value	Object

Returns
Type	Description
Field.TtlConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setField(Descriptors.FieldDescriptor field, Object value)

setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

public Field.TtlConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

Parameters
Name	Description
field	FieldDescriptor
index	int
value	Object

Returns
Type	Description
Field.TtlConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)

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];

Parameter
Name	Description
value	Field.TtlConfig.State The state to set.

Returns
Type	Description
Field.TtlConfig.Builder	This builder for chaining.

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
value	int The enum numeric value on the wire for state to set.

Returns
Type	Description
Field.TtlConfig.Builder	This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Field.TtlConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)

Parameter
Name	Description
unknownFields	UnknownFieldSet

Returns
Type	Description
Field.TtlConfig.Builder

Overrides

GeneratedMessageV3.Builder<BuilderType>.setUnknownFields(UnknownFieldSet unknownFields)