Package com.google.firestore.v1

Interface DocumentOrBuilder

All Superinterfaces:
com.google.protobuf.MessageLiteOrBuilder, com.google.protobuf.MessageOrBuilder
All Known Implementing Classes:
Document, Document.Builder
public interface DocumentOrBuilder extends com.google.protobuf.MessageOrBuilder

  • Method Summary

    Modifier and Type
    Method
    Description
    boolean
    containsFields(String key)
    The document's fields.
    com.google.protobuf.Timestamp
    getCreateTime()
    Output only.
    com.google.protobuf.TimestampOrBuilder
    getCreateTimeOrBuilder()
    Output only.
    Map<String,Value>
    getFields()
    Deprecated.
    int
    getFieldsCount()
    The document's fields.
    Map<String,Value>
    getFieldsMap()
    The document's fields.
    Value
    getFieldsOrDefault(String key, Value defaultValue)
    The document's fields.
    Value
    getFieldsOrThrow(String key)
    The document's fields.
    String
    getName()
    The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
    com.google.protobuf.ByteString
    getNameBytes()
    The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
    com.google.protobuf.Timestamp
    getUpdateTime()
    Output only.
    com.google.protobuf.TimestampOrBuilder
    getUpdateTimeOrBuilder()
    Output only.
    boolean
    hasCreateTime()
    Output only.
    boolean
    hasUpdateTime()
    Output only.

    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

    • getName

      String getName()
       The resource name of the document, for example
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
      string name = 1;
      Returns:
      The name.

    • getNameBytes

      com.google.protobuf.ByteString getNameBytes()
       The resource name of the document, for example
 `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
      string name = 1;
      Returns:
      The bytes for name.

    • getFieldsCount

      int getFieldsCount()
       The document's fields.

 The map keys represent field names.

 Field names matching the regular expression `__.*__` are reserved. Reserved
 field names are forbidden except in certain documented contexts. The field
 names, represented as UTF-8, must not exceed 1,500 bytes and cannot be
 empty.

 Field paths may be used in other contexts to refer to structured fields
 defined here. For `map_value`, the field path is represented by a
 dot-delimited (`.`) string of segments. Each segment is either a simple
 field name (defined below) or a quoted field name. For example, the
 structured field `"foo" : { map_value: { "x&y" : { string_value: "hello"
 }}}` would be represented by the field path `` foo.`x&y` ``.

 A simple field name contains only characters `a` to `z`, `A` to `Z`,
 `0` to `9`, or `_`, and must not start with `0` to `9`. For example,
 `foo_bar_17`.

 A quoted field name starts and ends with `` ` `` and
 may contain any character. Some characters, including `` ` ``, must be
 escaped using a `\`. For example, `` `x&y` `` represents `x&y` and
 `` `bak\`tik` `` represents `` bak`tik ``.
      map<string, .google.firestore.v1.Value> fields = 2;

    • containsFields

      boolean containsFields(String key)
       The document's fields.

 The map keys represent field names.

 Field names matching the regular expression `__.*__` are reserved. Reserved
 field names are forbidden except in certain documented contexts. The field
 names, represented as UTF-8, must not exceed 1,500 bytes and cannot be
 empty.

 Field paths may be used in other contexts to refer to structured fields
 defined here. For `map_value`, the field path is represented by a
 dot-delimited (`.`) string of segments. Each segment is either a simple
 field name (defined below) or a quoted field name. For example, the
 structured field `"foo" : { map_value: { "x&y" : { string_value: "hello"
 }}}` would be represented by the field path `` foo.`x&y` ``.

 A simple field name contains only characters `a` to `z`, `A` to `Z`,
 `0` to `9`, or `_`, and must not start with `0` to `9`. For example,
 `foo_bar_17`.

 A quoted field name starts and ends with `` ` `` and
 may contain any character. Some characters, including `` ` ``, must be
 escaped using a `\`. For example, `` `x&y` `` represents `x&y` and
 `` `bak\`tik` `` represents `` bak`tik ``.
      map<string, .google.firestore.v1.Value> fields = 2;

    • getFields

      @Deprecated Map<String,Value> getFields()
      Deprecated.
      Use getFieldsMap() instead.

    • getFieldsMap

      Map<String,Value> getFieldsMap()
       The document's fields.

 The map keys represent field names.

 Field names matching the regular expression `__.*__` are reserved. Reserved
 field names are forbidden except in certain documented contexts. The field
 names, represented as UTF-8, must not exceed 1,500 bytes and cannot be
 empty.

 Field paths may be used in other contexts to refer to structured fields
 defined here. For `map_value`, the field path is represented by a
 dot-delimited (`.`) string of segments. Each segment is either a simple
 field name (defined below) or a quoted field name. For example, the
 structured field `"foo" : { map_value: { "x&y" : { string_value: "hello"
 }}}` would be represented by the field path `` foo.`x&y` ``.

 A simple field name contains only characters `a` to `z`, `A` to `Z`,
 `0` to `9`, or `_`, and must not start with `0` to `9`. For example,
 `foo_bar_17`.

 A quoted field name starts and ends with `` ` `` and
 may contain any character. Some characters, including `` ` ``, must be
 escaped using a `\`. For example, `` `x&y` `` represents `x&y` and
 `` `bak\`tik` `` represents `` bak`tik ``.
      map<string, .google.firestore.v1.Value> fields = 2;

    • getFieldsOrDefault

      Value getFieldsOrDefault(String key, Value defaultValue)
       The document's fields.

 The map keys represent field names.

 Field names matching the regular expression `__.*__` are reserved. Reserved
 field names are forbidden except in certain documented contexts. The field
 names, represented as UTF-8, must not exceed 1,500 bytes and cannot be
 empty.

 Field paths may be used in other contexts to refer to structured fields
 defined here. For `map_value`, the field path is represented by a
 dot-delimited (`.`) string of segments. Each segment is either a simple
 field name (defined below) or a quoted field name. For example, the
 structured field `"foo" : { map_value: { "x&y" : { string_value: "hello"
 }}}` would be represented by the field path `` foo.`x&y` ``.

 A simple field name contains only characters `a` to `z`, `A` to `Z`,
 `0` to `9`, or `_`, and must not start with `0` to `9`. For example,
 `foo_bar_17`.

 A quoted field name starts and ends with `` ` `` and
 may contain any character. Some characters, including `` ` ``, must be
 escaped using a `\`. For example, `` `x&y` `` represents `x&y` and
 `` `bak\`tik` `` represents `` bak`tik ``.
      map<string, .google.firestore.v1.Value> fields = 2;

    • getFieldsOrThrow

      Value getFieldsOrThrow(String key)
       The document's fields.

 The map keys represent field names.

 Field names matching the regular expression `__.*__` are reserved. Reserved
 field names are forbidden except in certain documented contexts. The field
 names, represented as UTF-8, must not exceed 1,500 bytes and cannot be
 empty.

 Field paths may be used in other contexts to refer to structured fields
 defined here. For `map_value`, the field path is represented by a
 dot-delimited (`.`) string of segments. Each segment is either a simple
 field name (defined below) or a quoted field name. For example, the
 structured field `"foo" : { map_value: { "x&y" : { string_value: "hello"
 }}}` would be represented by the field path `` foo.`x&y` ``.

 A simple field name contains only characters `a` to `z`, `A` to `Z`,
 `0` to `9`, or `_`, and must not start with `0` to `9`. For example,
 `foo_bar_17`.

 A quoted field name starts and ends with `` ` `` and
 may contain any character. Some characters, including `` ` ``, must be
 escaped using a `\`. For example, `` `x&y` `` represents `x&y` and
 `` `bak\`tik` `` represents `` bak`tik ``.
      map<string, .google.firestore.v1.Value> fields = 2;

    • hasCreateTime

      boolean hasCreateTime()
       Output only. The time at which the document was created.

 This value increases monotonically when a document is deleted then
 recreated. It can also be compared to values from other documents and
 the `read_time` of a query.
      .google.protobuf.Timestamp create_time = 3;
      Returns:
      Whether the createTime field is set.

    • getCreateTime

      com.google.protobuf.Timestamp getCreateTime()
       Output only. The time at which the document was created.

 This value increases monotonically when a document is deleted then
 recreated. It can also be compared to values from other documents and
 the `read_time` of a query.
      .google.protobuf.Timestamp create_time = 3;
      Returns:
      The createTime.

    • getCreateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder()
       Output only. The time at which the document was created.

 This value increases monotonically when a document is deleted then
 recreated. It can also be compared to values from other documents and
 the `read_time` of a query.
      .google.protobuf.Timestamp create_time = 3;

    • hasUpdateTime

      boolean hasUpdateTime()
       Output only. The time at which the document was last changed.

 This value is initially set to the `create_time` then increases
 monotonically with each change to the document. It can also be
 compared to values from other documents and the `read_time` of a query.
      .google.protobuf.Timestamp update_time = 4;
      Returns:
      Whether the updateTime field is set.

    • getUpdateTime

      com.google.protobuf.Timestamp getUpdateTime()
       Output only. The time at which the document was last changed.

 This value is initially set to the `create_time` then increases
 monotonically with each change to the document. It can also be
 compared to values from other documents and the `read_time` of a query.
      .google.protobuf.Timestamp update_time = 4;
      Returns:
      The updateTime.

    • getUpdateTimeOrBuilder

      com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder()
       Output only. The time at which the document was last changed.

 This value is initially set to the `create_time` then increases
 monotonically with each change to the document. It can also be
 compared to values from other documents and the `read_time` of a query.
      .google.protobuf.Timestamp update_time = 4;