Class Field.TtlConfig (3.4.2)

Stay organized with collections Save and categorize content based on your preferences.
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. 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 Fields

STATE_FIELD_NUMBER

public static final int STATE_FIELD_NUMBER
Field Value
TypeDescription
int

Static Methods

getDefaultInstance()

public static Field.TtlConfig getDefaultInstance()
Returns
TypeDescription
Field.TtlConfig

getDescriptor()

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

newBuilder()

public static Field.TtlConfig.Builder newBuilder()
Returns
TypeDescription
Field.TtlConfig.Builder

newBuilder(Field.TtlConfig prototype)

public static Field.TtlConfig.Builder newBuilder(Field.TtlConfig prototype)
Parameter
NameDescription
prototypeField.TtlConfig
Returns
TypeDescription
Field.TtlConfig.Builder

parseDelimitedFrom(InputStream input)

public static Field.TtlConfig parseDelimitedFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Field.TtlConfig
Exceptions
TypeDescription
IOException

parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Field.TtlConfig parseDelimitedFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Field.TtlConfig
Exceptions
TypeDescription
IOException

parseFrom(byte[] data)

public static Field.TtlConfig parseFrom(byte[] data)
Parameter
NameDescription
databyte[]
Returns
TypeDescription
Field.TtlConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)

public static Field.TtlConfig parseFrom(byte[] data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
databyte[]
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Field.TtlConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data)

public static Field.TtlConfig parseFrom(ByteString data)
Parameter
NameDescription
dataByteString
Returns
TypeDescription
Field.TtlConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)

public static Field.TtlConfig parseFrom(ByteString data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteString
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Field.TtlConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(CodedInputStream input)

public static Field.TtlConfig parseFrom(CodedInputStream input)
Parameter
NameDescription
inputCodedInputStream
Returns
TypeDescription
Field.TtlConfig
Exceptions
TypeDescription
IOException

parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)

public static Field.TtlConfig parseFrom(CodedInputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputCodedInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Field.TtlConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input)

public static Field.TtlConfig parseFrom(InputStream input)
Parameter
NameDescription
inputInputStream
Returns
TypeDescription
Field.TtlConfig
Exceptions
TypeDescription
IOException

parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)

public static Field.TtlConfig parseFrom(InputStream input, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
inputInputStream
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Field.TtlConfig
Exceptions
TypeDescription
IOException

parseFrom(ByteBuffer data)

public static Field.TtlConfig parseFrom(ByteBuffer data)
Parameter
NameDescription
dataByteBuffer
Returns
TypeDescription
Field.TtlConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)

public static Field.TtlConfig parseFrom(ByteBuffer data, ExtensionRegistryLite extensionRegistry)
Parameters
NameDescription
dataByteBuffer
extensionRegistryExtensionRegistryLite
Returns
TypeDescription
Field.TtlConfig
Exceptions
TypeDescription
InvalidProtocolBufferException

parser()

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

Methods

equals(Object obj)

public boolean equals(Object obj)
Parameter
NameDescription
objObject
Returns
TypeDescription
boolean
Overrides

getDefaultInstanceForType()

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

getParserForType()

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

getSerializedSize()

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

getUnknownFields()

public final UnknownFieldSet getUnknownFields()
Returns
TypeDescription
UnknownFieldSet
Overrides

hashCode()

public int hashCode()
Returns
TypeDescription
int
Overrides

internalGetFieldAccessorTable()

protected GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
Returns
TypeDescription
FieldAccessorTable
Overrides

isInitialized()

public final boolean isInitialized()
Returns
TypeDescription
boolean
Overrides

newBuilderForType()

public Field.TtlConfig.Builder newBuilderForType()
Returns
TypeDescription
Field.TtlConfig.Builder

newBuilderForType(GeneratedMessageV3.BuilderParent parent)

protected Field.TtlConfig.Builder newBuilderForType(GeneratedMessageV3.BuilderParent parent)
Parameter
NameDescription
parentBuilderParent
Returns
TypeDescription
Field.TtlConfig.Builder
Overrides

newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)

protected Object newInstance(GeneratedMessageV3.UnusedPrivateParameter unused)
Parameter
NameDescription
unusedUnusedPrivateParameter
Returns
TypeDescription
Object
Overrides

toBuilder()

public Field.TtlConfig.Builder toBuilder()
Returns
TypeDescription
Field.TtlConfig.Builder

writeTo(CodedOutputStream output)

public void writeTo(CodedOutputStream output)
Parameter
NameDescription
outputCodedOutputStream
Overrides Exceptions
TypeDescription
IOException