com.google.firestore.v1.DocumentOrBuilder Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of proto-google-cloud-firestore-v1 Show documentation
Show all versions of proto-google-cloud-firestore-v1 Show documentation
PROTO library for proto-google-cloud-firestore-v1
/*
* Copyright 2024 Google LLC
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* https://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
// Generated by the protocol buffer compiler. DO NOT EDIT!
// source: google/firestore/v1/document.proto
// Protobuf Java Version: 3.25.4
package com.google.firestore.v1;
public interface DocumentOrBuilder
extends
// @@protoc_insertion_point(interface_extends:google.firestore.v1.Document)
com.google.protobuf.MessageOrBuilder {
/**
*
*
*
* The resource name of the document, for example
* `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
*
*
* string name = 1;
*
* @return The name.
*/
java.lang.String getName();
/**
*
*
*
* The resource name of the document, for example
* `projects/{project_id}/databases/{database_id}/documents/{document_path}`.
*
*
* string name = 1;
*
* @return The bytes for name.
*/
com.google.protobuf.ByteString getNameBytes();
/**
*
*
*
* 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;
*/
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;
*/
boolean containsFields(java.lang.String key);
/** Use {@link #getFieldsMap()} instead. */
@java.lang.Deprecated
java.util.Map getFields();
/**
*
*
*
* 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;
*/
java.util.Map 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;
*/
/* nullable */
com.google.firestore.v1.Value getFieldsOrDefault(
java.lang.String key,
/* nullable */
com.google.firestore.v1.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;
*/
com.google.firestore.v1.Value getFieldsOrThrow(java.lang.String key);
/**
*
*
*
* 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;
*
* @return Whether the createTime field is set.
*/
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;
*
* @return The createTime.
*/
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;
*/
com.google.protobuf.TimestampOrBuilder getCreateTimeOrBuilder();
/**
*
*
*
* 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;
*
* @return Whether the updateTime field is set.
*/
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;
*
* @return The updateTime.
*/
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;
*/
com.google.protobuf.TimestampOrBuilder getUpdateTimeOrBuilder();
}
© 2015 - 2024 Weber Informatics LLC | Privacy Policy