Class Field.TtlConfig (3.24.3)

public static final class Field.TtlConfig extends GeneratedMessageV3 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. Timestamp values in the past indicate 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

Static Fields

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
Type Description
int

Static Methods

getDefaultInstance()

public static Field.TtlConfig getDefaultInstance()
Returns
Type Description
Field.TtlConfig

getDescriptor()

public static final Descriptors.Descriptor getDescriptor()
Returns
Type Description
Descriptor

newBuilder()

public static Field.TtlConfig.Builder newBuilder()
Returns
Type Description
Field.TtlConfig.Builder

newBuilder(Field.TtlConfig prototype)

public static Field.TtlConfig.Builder newBuilder(Field.TtlConfig prototype)
Parameter
Name Description
prototype Field.TtlConfig
Returns
Type Description
Field.TtlConfig.Builder

parseDelimitedFrom(InputStream input)

public static Field.TtlConfig parseDelimitedFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Field.TtlConfig
Exceptions
Type Description
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Field.TtlConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Field.TtlConfig
Exceptions
Type Description
IOException

parseFrom(byte[] data)

public static Field.TtlConfig parseFrom(byte[] data)
Parameter
Name Description
data byte[]
Returns
Type Description
Field.TtlConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Field.TtlConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data byte[]
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Field.TtlConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Field.TtlConfig parseFrom(ByteString data)
Parameter
Name Description
data ByteString
Returns
Type Description
Field.TtlConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Field.TtlConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteString
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Field.TtlConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Field.TtlConfig parseFrom(CodedInputStream input)
Parameter
Name Description
input CodedInputStream
Returns
Type Description
Field.TtlConfig
Exceptions
Type Description
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Field.TtlConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input CodedInputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Field.TtlConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input)

public static Field.TtlConfig parseFrom(InputStream input)
Parameter
Name Description
input InputStream
Returns
Type Description
Field.TtlConfig
Exceptions
Type Description
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Field.TtlConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
input InputStream
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Field.TtlConfig
Exceptions
Type Description
IOException

parseFrom(ByteBuffer data)

public static Field.TtlConfig parseFrom(ByteBuffer data)
Parameter
Name Description
data ByteBuffer
Returns
Type Description
Field.TtlConfig
Exceptions
Type Description
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Field.TtlConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
Name Description
data ByteBuffer
extensionRegistry ExtensionRegistryLite
Returns
Type Description
Field.TtlConfig
Exceptions
Type Description
InvalidProtocolBufferException

parser()

public static Parser<Field.TtlConfig> parser()
Returns
Type Description
Parser<TtlConfig>

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
Name Description
obj Object
Returns
Type Description
boolean
Overrides

getDefaultInstanceForType()

public Field.TtlConfig getDefaultInstanceForType()
Returns
Type Description
Field.TtlConfig

getParserForType()

public Parser<Field.TtlConfig> getParserForType()
Returns
Type Description
Parser<TtlConfig>
Overrides

getSerializedSize()

public int getSerializedSize()
Returns
Type Description
int
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
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.

hashCode()

public int hashCode()
Returns
Type Description
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
Type Description
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
Type Description
boolean
Overrides

newBuilderForType()

public Field.TtlConfig.Builder newBuilderForType()
Returns
Type Description
Field.TtlConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Field.TtlConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
Name Description
parent BuilderParent
Returns
Type Description
Field.TtlConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
Name Description
unused UnusedPrivateParameter
Returns
Type Description
Object
Overrides

toBuilder()

public Field.TtlConfig.Builder toBuilder()
Returns
Type Description
Field.TtlConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
Name Description
output CodedOutputStream
Overrides
Exceptions
Type Description
IOException