Class Field.TtlConfig.Builder (3.16.3)

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

Static Methods

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
TypeDescription
Descriptor

Methods

addRepeatedField(Descriptors.FieldDescriptor field, Object value)

public Field.TtlConfig.Builder addRepeatedField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Field.TtlConfig.Builder
Overrides

build()

public Field.TtlConfig build()
Returns
TypeDescription
Field.TtlConfig

buildPartial()

public Field.TtlConfig buildPartial()
Returns
TypeDescription
Field.TtlConfig

clear()

public Field.TtlConfig.Builder clear()
Returns
TypeDescription
Field.TtlConfig.Builder
Overrides

clearField(Descriptors.FieldDescriptor field)

public Field.TtlConfig.Builder clearField(Descriptors.FieldDescriptor field)
Parameter
NameDescription
fieldFieldDescriptor
Returns
TypeDescription
Field.TtlConfig.Builder
Overrides

clearOneof(Descriptors.OneofDescriptor oneof)

public Field.TtlConfig.Builder clearOneof(Descriptors.OneofDescriptor oneof)
Parameter
NameDescription
oneofOneofDescriptor
Returns
TypeDescription
Field.TtlConfig.Builder
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];

Returns
TypeDescription
Field.TtlConfig.Builder

This builder for chaining.

clone()

public Field.TtlConfig.Builder clone()
Returns
TypeDescription
Field.TtlConfig.Builder
Overrides

getDefaultInstanceForType()

public Field.TtlConfig getDefaultInstanceForType()
Returns
TypeDescription
Field.TtlConfig

getDescriptorForType()

public Descriptors.Descriptor getDescriptorForType()
Returns
TypeDescription
Descriptor
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];

Returns
TypeDescription
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
TypeDescription
int

The enum numeric value on the wire for state.

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

mergeFrom(Field.TtlConfig other)

public Field.TtlConfig.Builder mergeFrom(Field.TtlConfig other)
Parameter
NameDescription
otherField.TtlConfig
Returns
TypeDescription
Field.TtlConfig.Builder

mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public Field.TtlConfig.Builder mergeFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Field.TtlConfig.Builder
Overrides
Exceptions
TypeDescription
IOException

mergeFrom(Message other)

public Field.TtlConfig.Builder mergeFrom(Message other)
Parameter
NameDescription
otherMessage
Returns
TypeDescription
Field.TtlConfig.Builder
Overrides

mergeUnknownFields(UnknownFieldSet unknownFields)

public final Field.TtlConfig.Builder mergeUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Field.TtlConfig.Builder
Overrides

setField(Descriptors.FieldDescriptor field, Object value)

public Field.TtlConfig.Builder setField(Descriptors.FieldDescriptor field, Object value)
Parameters
NameDescription
fieldFieldDescriptor
valueObject
Returns
TypeDescription
Field.TtlConfig.Builder
Overrides

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

public Field.TtlConfig.Builder setRepeatedField(Descriptors.FieldDescriptor field, int index, Object value)
Parameters
NameDescription
fieldFieldDescriptor
indexint
valueObject
Returns
TypeDescription
Field.TtlConfig.Builder
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];

Parameter
NameDescription
valueField.TtlConfig.State

The state to set.

Returns
TypeDescription
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
NameDescription
valueint

The enum numeric value on the wire for state to set.

Returns
TypeDescription
Field.TtlConfig.Builder

This builder for chaining.

setUnknownFields(UnknownFieldSet unknownFields)

public final Field.TtlConfig.Builder setUnknownFields(UnknownFieldSet unknownFields)
Parameter
NameDescription
unknownFieldsUnknownFieldSet
Returns
TypeDescription
Field.TtlConfig.Builder
Overrides