Package com.google.firestore.admin.v1

Interface Field.TtlConfigOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Field.TtlConfig, Field.TtlConfig.Builder
Enclosing class:
Field
public static interface Field.TtlConfigOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    com.google.protobuf.Duration
    getExpirationOffset()
    Optional.
    com.google.protobuf.DurationOrBuilder
    getExpirationOffsetOrBuilder()
    Optional.
    Field.TtlConfig.State
    getState()
    Output only.
    int
    getStateValue()
    Output only.
    boolean
    hasExpirationOffset()
    Optional.

    Methods inherited from interface com.google.protobuf.MessageLiteOrBuilder

    isInitialized

    Methods inherited from interface com.google.protobuf.MessageOrBuilder

    findInitializationErrors, getAllFields, getDefaultInstanceForType, getDescriptorForType, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

  • Method Details

    • getStateValue

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

    • getState

      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:
      The state.

    • hasExpirationOffset

      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:
      Whether the expirationOffset field is set.

    • getExpirationOffset

      com.google.protobuf.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:
      The expirationOffset.

    • getExpirationOffsetOrBuilder

      com.google.protobuf.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];