Interface Field.TtlConfigOrBuilder (3.41.0)

public static interface Field.TtlConfigOrBuilder extends MessageOrBuilder

Implements

public abstract Duration getExpirationOffset()

Optional. The offset, relative to the timestamp value from the TTL-enabled field, used to determine the document's expiration time.

expiration_offset.seconds must be between 0 and 2,147,483,647 inclusive. Values more precise than seconds are rejected.

If unset, defaults to 0, in which case the expiration time is the same as the timestamp value from the TTL-enabled field.

.google.protobuf.Duration expiration_offset = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`Duration`	The expirationOffset.

public abstract DurationOrBuilder getExpirationOffsetOrBuilder()

Optional. The offset, relative to the timestamp value from the TTL-enabled field, used to determine the document's expiration time.

expiration_offset.seconds must be between 0 and 2,147,483,647 inclusive. Values more precise than seconds are rejected.

If unset, defaults to 0, in which case the expiration time is the same as the timestamp value from the TTL-enabled field.

.google.protobuf.Duration expiration_offset = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`DurationOrBuilder`

public abstract 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.

public abstract 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.

public abstract boolean hasExpirationOffset()

Optional. The offset, relative to the timestamp value from the TTL-enabled field, used to determine the document's expiration time.

expiration_offset.seconds must be between 0 and 2,147,483,647 inclusive. Values more precise than seconds are rejected.

If unset, defaults to 0, in which case the expiration time is the same as the timestamp value from the TTL-enabled field.

.google.protobuf.Duration expiration_offset = 3 [(.google.api.field_behavior) = OPTIONAL];

Returns
Type	Description
`boolean`	Whether the expirationOffset field is set.