Field.TtlConfig.Builder (Google Cloud Firestore Parent 3.13.2 API)

java.lang.Object
- com.google.protobuf.AbstractMessageLite.Builder
- - com.google.protobuf.AbstractMessage.Builder<BuilderT>
  - - com.google.protobuf.GeneratedMessageV3.Builder<Field.TtlConfig.Builder>
    - - com.google.firestore.admin.v1.Field.TtlConfig.Builder

All Implemented Interfaces:: Field.TtlConfigOrBuilder, com.google.protobuf.Message.Builder, com.google.protobuf.MessageLite.Builder, com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder, Cloneable

Enclosing class:: Field.TtlConfig

public static final class Field.TtlConfig.Builder
extends com.google.protobuf.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

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`Field.TtlConfig.Builder`	`addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Field.TtlConfig`	`build()`
`Field.TtlConfig`	`buildPartial()`
`Field.TtlConfig.Builder`	`clear()`
`Field.TtlConfig.Builder`	`clearField(com.google.protobuf.Descriptors.FieldDescriptor field)`
`Field.TtlConfig.Builder`	`clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)`
`Field.TtlConfig.Builder`	`clearState()` Output only.
`Field.TtlConfig.Builder`	`clone()`
`Field.TtlConfig`	`getDefaultInstanceForType()`
`static com.google.protobuf.Descriptors.Descriptor`	`getDescriptor()`
`com.google.protobuf.Descriptors.Descriptor`	`getDescriptorForType()`
`Field.TtlConfig.State`	`getState()` Output only.
`int`	`getStateValue()` Output only.
`protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable`	`internalGetFieldAccessorTable()`
`boolean`	`isInitialized()`
`Field.TtlConfig.Builder`	`mergeFrom(com.google.protobuf.CodedInputStream input, com.google.protobuf.ExtensionRegistryLite extensionRegistry)`
`Field.TtlConfig.Builder`	`mergeFrom(Field.TtlConfig other)`
`Field.TtlConfig.Builder`	`mergeFrom(com.google.protobuf.Message other)`
`Field.TtlConfig.Builder`	`mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`
`Field.TtlConfig.Builder`	`setField(com.google.protobuf.Descriptors.FieldDescriptor field, Object value)`
`Field.TtlConfig.Builder`	`setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field, int index, Object value)`
`Field.TtlConfig.Builder`	`setState(Field.TtlConfig.State value)` Output only.
`Field.TtlConfig.Builder`	`setStateValue(int value)` Output only.
`Field.TtlConfig.Builder`	`setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)`

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder
getAllFields, getField, getFieldBuilder, getOneofFieldDescriptor, getParentForChildren, getRepeatedField, getRepeatedFieldBuilder, getRepeatedFieldCount, getUnknownFields, getUnknownFieldSetBuilder, hasField, hasOneof, internalGetMapField, internalGetMutableMapField, isClean, markClean, mergeUnknownLengthDelimitedField, mergeUnknownVarintField, newBuilderForField, onBuilt, onChanged, parseUnknownField, setUnknownFieldSetBuilder, setUnknownFieldsProto3

Methods inherited from class com.google.protobuf.AbstractMessage.Builder
findInitializationErrors, getInitializationErrorString, internalMergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, mergeFrom, newUninitializedMessageException, toString

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder
addAll, addAll, mergeDelimitedFrom, mergeDelimitedFrom, mergeFrom, newUninitializedMessageException

Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.google.protobuf.MessageOrBuilder
findInitializationErrors, getAllFields, getField, getInitializationErrorString, getOneofFieldDescriptor, getRepeatedField, getRepeatedFieldCount, getUnknownFields, hasField, hasOneof

Methods inherited from interface com.google.protobuf.Message.Builder
mergeDelimitedFrom, mergeDelimitedFrom

Methods inherited from interface com.google.protobuf.MessageLite.Builder
mergeFrom

- Method Detail
  - getDescriptor
```
public static final com.google.protobuf.Descriptors.Descriptor getDescriptor()
```
  - internalGetFieldAccessorTable
```
protected com.google.protobuf.GeneratedMessageV3.FieldAccessorTable internalGetFieldAccessorTable()
```
    Specified by:
    
    internalGetFieldAccessorTable in class com.google.protobuf.GeneratedMessageV3.Builder<Field.TtlConfig.Builder>
  - clear
```
public Field.TtlConfig.Builder clear()
```
    Specified by:
    
    clear in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clear in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clear in class com.google.protobuf.GeneratedMessageV3.Builder<Field.TtlConfig.Builder>
  - getDescriptorForType
```
public com.google.protobuf.Descriptors.Descriptor getDescriptorForType()
```
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    getDescriptorForType in interface com.google.protobuf.MessageOrBuilder
    
    Overrides:
    
    getDescriptorForType in class com.google.protobuf.GeneratedMessageV3.Builder<Field.TtlConfig.Builder>
  - getDefaultInstanceForType
```
public Field.TtlConfig getDefaultInstanceForType()
```
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageLiteOrBuilder
    
    Specified by:
    
    getDefaultInstanceForType in interface com.google.protobuf.MessageOrBuilder
  - build
```
public Field.TtlConfig build()
```
    Specified by:
    
    build in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    build in interface com.google.protobuf.MessageLite.Builder
  - buildPartial
```
public Field.TtlConfig buildPartial()
```
    Specified by:
    
    buildPartial in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    buildPartial in interface com.google.protobuf.MessageLite.Builder
  - clone
```
public Field.TtlConfig.Builder clone()
```
    Specified by:
    
    clone in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    clone in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    clone in class com.google.protobuf.GeneratedMessageV3.Builder<Field.TtlConfig.Builder>
  - setField
```
public Field.TtlConfig.Builder setField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                        Object value)
```
    Specified by:
    
    setField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setField in class com.google.protobuf.GeneratedMessageV3.Builder<Field.TtlConfig.Builder>
  - clearField
```
public Field.TtlConfig.Builder clearField(com.google.protobuf.Descriptors.FieldDescriptor field)
```
    Specified by:
    
    clearField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearField in class com.google.protobuf.GeneratedMessageV3.Builder<Field.TtlConfig.Builder>
  - clearOneof
```
public Field.TtlConfig.Builder clearOneof(com.google.protobuf.Descriptors.OneofDescriptor oneof)
```
    Specified by:
    
    clearOneof in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    clearOneof in class com.google.protobuf.GeneratedMessageV3.Builder<Field.TtlConfig.Builder>
  - setRepeatedField
```
public Field.TtlConfig.Builder setRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                int index,
                                                Object value)
```
    Specified by:
    
    setRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Field.TtlConfig.Builder>
  - addRepeatedField
```
public Field.TtlConfig.Builder addRepeatedField(com.google.protobuf.Descriptors.FieldDescriptor field,
                                                Object value)
```
    Specified by:
    
    addRepeatedField in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    addRepeatedField in class com.google.protobuf.GeneratedMessageV3.Builder<Field.TtlConfig.Builder>
  - mergeFrom
```
public Field.TtlConfig.Builder mergeFrom(com.google.protobuf.Message other)
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Field.TtlConfig.Builder>
  - mergeFrom
```
public Field.TtlConfig.Builder mergeFrom(Field.TtlConfig other)
```
  - isInitialized
```
public final boolean isInitialized()
```
    Specified by:
    
    isInitialized in interface com.google.protobuf.MessageLiteOrBuilder
    
    Overrides:
    
    isInitialized in class com.google.protobuf.GeneratedMessageV3.Builder<Field.TtlConfig.Builder>
  - mergeFrom
```
public Field.TtlConfig.Builder mergeFrom(com.google.protobuf.CodedInputStream input,
                                         com.google.protobuf.ExtensionRegistryLite extensionRegistry)
                                  throws IOException
```
    Specified by:
    
    mergeFrom in interface com.google.protobuf.Message.Builder
    
    Specified by:
    
    mergeFrom in interface com.google.protobuf.MessageLite.Builder
    
    Overrides:
    
    mergeFrom in class com.google.protobuf.AbstractMessage.Builder<Field.TtlConfig.Builder>
    
    Throws:
    
    IOException
  - 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];
    Specified by:
    
    getStateValue in interface Field.TtlConfigOrBuilder
    
    Returns:
    
    The enum numeric value on the wire for state.
  - setStateValue
```
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];
    Parameters:
    
    value - The enum numeric value on the wire for state to set.
    
    Returns:
    
    This builder for chaining.
  - 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];
    Specified by:
    
    getState in interface Field.TtlConfigOrBuilder
    
    Returns:
    
    The state.
  - setState
```
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];
    Parameters:
    
    value - The state to set.
    
    Returns:
    
    This builder for chaining.
  - 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:
    
    This builder for chaining.
  - setUnknownFields
```
public final Field.TtlConfig.Builder setUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    setUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    setUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Field.TtlConfig.Builder>
  - mergeUnknownFields
```
public final Field.TtlConfig.Builder mergeUnknownFields(com.google.protobuf.UnknownFieldSet unknownFields)
```
    Specified by:
    
    mergeUnknownFields in interface com.google.protobuf.Message.Builder
    
    Overrides:
    
    mergeUnknownFields in class com.google.protobuf.GeneratedMessageV3.Builder<Field.TtlConfig.Builder>

Class Field.TtlConfig.Builder

Method Summary

Methods inherited from class com.google.protobuf.GeneratedMessageV3.Builder

Methods inherited from class com.google.protobuf.AbstractMessage.Builder

Methods inherited from class com.google.protobuf.AbstractMessageLite.Builder

Methods inherited from class java.lang.Object

Methods inherited from interface com.google.protobuf.MessageOrBuilder

Methods inherited from interface com.google.protobuf.Message.Builder

Methods inherited from interface com.google.protobuf.MessageLite.Builder

Method Detail

getDescriptor

internalGetFieldAccessorTable

clear

getDescriptorForType

getDefaultInstanceForType

build

buildPartial

clone

setField

clearField

clearOneof

setRepeatedField

addRepeatedField

mergeFrom

mergeFrom

isInitialized

mergeFrom

getStateValue

setStateValue

getState

setState

clearState

setUnknownFields

mergeUnknownFields