googleapis
Version:
Google APIs Client Library for Node.js
964 lines • 372 kB
TypeScript
import { OAuth2Client, JWT, Compute, UserRefreshClient, BaseExternalAccountClient, GaxiosResponseWithHTTP2, GoogleConfigurable, MethodOptions, StreamMethodOptions, GlobalOptions, GoogleAuth, BodyResponseCallback, APIRequestContext } from 'googleapis-common';
import { Readable } from 'stream';
export declare namespace firestore_v1 {
export interface Options extends GlobalOptions {
version: 'v1';
}
interface StandardParameters {
/**
* Auth client or API Key for the request
*/
auth?: string | OAuth2Client | JWT | Compute | UserRefreshClient | BaseExternalAccountClient | GoogleAuth;
/**
* V1 error format.
*/
'$.xgafv'?: string;
/**
* OAuth access token.
*/
access_token?: string;
/**
* Data format for response.
*/
alt?: string;
/**
* JSONP
*/
callback?: string;
/**
* Selector specifying which fields to include in a partial response.
*/
fields?: string;
/**
* API key. Your API key identifies your project and provides you with API access, quota, and reports. Required unless you provide an OAuth 2.0 token.
*/
key?: string;
/**
* OAuth 2.0 token for the current user.
*/
oauth_token?: string;
/**
* Returns response with indentations and line breaks.
*/
prettyPrint?: boolean;
/**
* Available to use for quota purposes for server-side applications. Can be any arbitrary string assigned to a user, but should not exceed 40 characters.
*/
quotaUser?: string;
/**
* Legacy upload protocol for media (e.g. "media", "multipart").
*/
uploadType?: string;
/**
* Upload protocol for media (e.g. "raw", "multipart").
*/
upload_protocol?: string;
}
/**
* Cloud Firestore API
*
* Accesses the NoSQL document database built for automatic scaling, high performance, and ease of application development.
*
* @example
* ```js
* const {google} = require('googleapis');
* const firestore = google.firestore('v1');
* ```
*/
export class Firestore {
context: APIRequestContext;
projects: Resource$Projects;
constructor(options: GlobalOptions, google?: GoogleConfigurable);
}
/**
* Defines an aggregation that produces a single result.
*/
export interface Schema$Aggregation {
/**
* Optional. Optional name of the field to store the result of the aggregation into. If not provided, Firestore will pick a default name following the format `field_`. For example: ``` AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2), COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) OVER ( ... ); ``` becomes: ``` AGGREGATE COUNT_UP_TO(1) AS count_up_to_1, COUNT_UP_TO(2) AS field_1, COUNT_UP_TO(3) AS count_up_to_3, COUNT(*) AS field_2 OVER ( ... ); ``` Requires: * Must be unique across all aggregation aliases. * Conform to document field name limitations.
*/
alias?: string | null;
/**
* Average aggregator.
*/
avg?: Schema$Avg;
/**
* Count aggregator.
*/
count?: Schema$Count;
/**
* Sum aggregator.
*/
sum?: Schema$Sum;
}
/**
* The result of a single bucket from a Firestore aggregation query. The keys of `aggregate_fields` are the same for all results in an aggregation query, unlike document queries which can have different fields present for each result.
*/
export interface Schema$AggregationResult {
/**
* The result of the aggregation functions, ex: `COUNT(*) AS total_docs`. The key is the alias assigned to the aggregation function on input and the size of this map equals the number of aggregation functions in the query.
*/
aggregateFields?: {
[key: string]: Schema$Value;
} | null;
}
/**
* An array value.
*/
export interface Schema$ArrayValue {
/**
* Values in the array.
*/
values?: Schema$Value[];
}
/**
* Average of the values of the requested field. * Only numeric values will be aggregated. All non-numeric values including `NULL` are skipped. * If the aggregated values contain `NaN`, returns `NaN`. Infinity math follows IEEE-754 standards. * If the aggregated value set is empty, returns `NULL`. * Always returns the result as a double.
*/
export interface Schema$Avg {
/**
* The field to aggregate on.
*/
field?: Schema$FieldReference;
}
/**
* The request for Firestore.BatchGetDocuments.
*/
export interface Schema$BatchGetDocumentsRequest {
/**
* The names of the documents to retrieve. In the format: `projects/{project_id\}/databases/{database_id\}/documents/{document_path\}`. The request will fail if any of the document is not a child resource of the given `database`. Duplicate names will be elided.
*/
documents?: string[] | null;
/**
* The fields to return. If not set, returns all fields. If a document has a field that is not present in this mask, that field will not be returned in the response.
*/
mask?: Schema$DocumentMask;
/**
* Starts a new transaction and reads the documents. Defaults to a read-only transaction. The new transaction ID will be returned as the first response in the stream.
*/
newTransaction?: Schema$TransactionOptions;
/**
* Reads documents as they were at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
*/
readTime?: string | null;
/**
* Reads documents in a transaction.
*/
transaction?: string | null;
}
/**
* The streamed response for Firestore.BatchGetDocuments.
*/
export interface Schema$BatchGetDocumentsResponse {
/**
* A document that was requested.
*/
found?: Schema$Document;
/**
* A document name that was requested but does not exist. In the format: `projects/{project_id\}/databases/{database_id\}/documents/{document_path\}`.
*/
missing?: string | null;
/**
* The time at which the document was read. This may be monotically increasing, in this case the previous documents in the result stream are guaranteed not to have changed between their read_time and this one.
*/
readTime?: string | null;
/**
* The transaction that was started as part of this request. Will only be set in the first response, and only if BatchGetDocumentsRequest.new_transaction was set in the request.
*/
transaction?: string | null;
}
/**
* The request for Firestore.BatchWrite.
*/
export interface Schema$BatchWriteRequest {
/**
* Labels associated with this batch write.
*/
labels?: {
[key: string]: string;
} | null;
/**
* The writes to apply. Method does not apply writes atomically and does not guarantee ordering. Each write succeeds or fails independently. You cannot write to the same document more than once per request.
*/
writes?: Schema$Write[];
}
/**
* The response from Firestore.BatchWrite.
*/
export interface Schema$BatchWriteResponse {
/**
* The status of applying the writes. This i-th write status corresponds to the i-th write in the request.
*/
status?: Schema$Status[];
/**
* The result of applying the writes. This i-th write result corresponds to the i-th write in the request.
*/
writeResults?: Schema$WriteResult[];
}
/**
* The request for Firestore.BeginTransaction.
*/
export interface Schema$BeginTransactionRequest {
/**
* The options for the transaction. Defaults to a read-write transaction.
*/
options?: Schema$TransactionOptions;
}
/**
* The response for Firestore.BeginTransaction.
*/
export interface Schema$BeginTransactionResponse {
/**
* The transaction that was started.
*/
transaction?: string | null;
}
/**
* A sequence of bits, encoded in a byte array. Each byte in the `bitmap` byte array stores 8 bits of the sequence. The only exception is the last byte, which may store 8 _or fewer_ bits. The `padding` defines the number of bits of the last byte to be ignored as "padding". The values of these "padding" bits are unspecified and must be ignored. To retrieve the first bit, bit 0, calculate: `(bitmap[0] & 0x01) != 0`. To retrieve the second bit, bit 1, calculate: `(bitmap[0] & 0x02) != 0`. To retrieve the third bit, bit 2, calculate: `(bitmap[0] & 0x04) != 0`. To retrieve the fourth bit, bit 3, calculate: `(bitmap[0] & 0x08) != 0`. To retrieve bit n, calculate: `(bitmap[n / 8] & (0x01 << (n % 8))) != 0`. The "size" of a `BitSequence` (the number of bits it contains) is calculated by this formula: `(bitmap.length * 8) - padding`.
*/
export interface Schema$BitSequence {
/**
* The bytes that encode the bit sequence. May have a length of zero.
*/
bitmap?: string | null;
/**
* The number of bits of the last byte in `bitmap` to ignore as "padding". If the length of `bitmap` is zero, then this value must be `0`. Otherwise, this value must be between 0 and 7, inclusive.
*/
padding?: number | null;
}
/**
* A bloom filter (https://en.wikipedia.org/wiki/Bloom_filter). The bloom filter hashes the entries with MD5 and treats the resulting 128-bit hash as 2 distinct 64-bit hash values, interpreted as unsigned integers using 2's complement encoding. These two hash values, named `h1` and `h2`, are then used to compute the `hash_count` hash values using the formula, starting at `i=0`: h(i) = h1 + (i * h2) These resulting values are then taken modulo the number of bits in the bloom filter to get the bits of the bloom filter to test for the given entry.
*/
export interface Schema$BloomFilter {
/**
* The bloom filter data.
*/
bits?: Schema$BitSequence;
/**
* The number of hashes used by the algorithm.
*/
hashCount?: number | null;
}
/**
* A selection of a collection, such as `messages as m1`.
*/
export interface Schema$CollectionSelector {
/**
* When false, selects only collections that are immediate children of the `parent` specified in the containing `RunQueryRequest`. When true, selects all descendant collections.
*/
allDescendants?: boolean | null;
/**
* The collection ID. When set, selects only collections with this ID.
*/
collectionId?: string | null;
}
/**
* The request for Firestore.Commit.
*/
export interface Schema$CommitRequest {
/**
* If set, applies all writes in this transaction, and commits it.
*/
transaction?: string | null;
/**
* The writes to apply. Always executed atomically and in order.
*/
writes?: Schema$Write[];
}
/**
* The response for Firestore.Commit.
*/
export interface Schema$CommitResponse {
/**
* The time at which the commit occurred. Any read with an equal or greater `read_time` is guaranteed to see the effects of the commit.
*/
commitTime?: string | null;
/**
* The result of applying the writes. This i-th write result corresponds to the i-th write in the request.
*/
writeResults?: Schema$WriteResult[];
}
/**
* A filter that merges multiple other filters using the given operator.
*/
export interface Schema$CompositeFilter {
/**
* The list of filters to combine. Requires: * At least one filter is present.
*/
filters?: Schema$Filter[];
/**
* The operator for combining multiple filters.
*/
op?: string | null;
}
/**
* Count of documents that match the query. The `COUNT(*)` aggregation function operates on the entire document so it does not require a field reference.
*/
export interface Schema$Count {
/**
* Optional. Optional constraint on the maximum number of documents to count. This provides a way to set an upper bound on the number of documents to scan, limiting latency, and cost. Unspecified is interpreted as no bound. High-Level Example: ``` AGGREGATE COUNT_UP_TO(1000) OVER ( SELECT * FROM k ); ``` Requires: * Must be greater than zero when present.
*/
upTo?: string | null;
}
/**
* A position in a query result set.
*/
export interface Schema$Cursor {
/**
* If the position is just before or just after the given values, relative to the sort order defined by the query.
*/
before?: boolean | null;
/**
* The values that represent a position, in the order they appear in the order by clause of a query. Can contain fewer values than specified in the order by clause.
*/
values?: Schema$Value[];
}
/**
* A Firestore document. Must not exceed 1 MiB - 4 bytes.
*/
export interface Schema$Document {
/**
* 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.
*/
createTime?: string | null;
/**
* 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 ``.
*/
fields?: {
[key: string]: Schema$Value;
} | null;
/**
* The resource name of the document, for example `projects/{project_id\}/databases/{database_id\}/documents/{document_path\}`.
*/
name?: string | null;
/**
* 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.
*/
updateTime?: string | null;
}
/**
* A Document has changed. May be the result of multiple writes, including deletes, that ultimately resulted in a new value for the Document. Multiple DocumentChange messages may be returned for the same logical change, if multiple targets are affected.
*/
export interface Schema$DocumentChange {
/**
* The new state of the Document. If `mask` is set, contains only fields that were updated or added.
*/
document?: Schema$Document;
/**
* A set of target IDs for targets that no longer match this document.
*/
removedTargetIds?: number[] | null;
/**
* A set of target IDs of targets that match this document.
*/
targetIds?: number[] | null;
}
/**
* A Document has been deleted. May be the result of multiple writes, including updates, the last of which deleted the Document. Multiple DocumentDelete messages may be returned for the same logical delete, if multiple targets are affected.
*/
export interface Schema$DocumentDelete {
/**
* The resource name of the Document that was deleted.
*/
document?: string | null;
/**
* The read timestamp at which the delete was observed. Greater or equal to the `commit_time` of the delete.
*/
readTime?: string | null;
/**
* A set of target IDs for targets that previously matched this entity.
*/
removedTargetIds?: number[] | null;
}
/**
* A set of field paths on a document. Used to restrict a get or update operation on a document to a subset of its fields. This is different from standard field masks, as this is always scoped to a Document, and takes in account the dynamic nature of Value.
*/
export interface Schema$DocumentMask {
/**
* The list of field paths in the mask. See Document.fields for a field path syntax reference.
*/
fieldPaths?: string[] | null;
}
/**
* A Document has been removed from the view of the targets. Sent if the document is no longer relevant to a target and is out of view. Can be sent instead of a DocumentDelete or a DocumentChange if the server can not send the new value of the document. Multiple DocumentRemove messages may be returned for the same logical write or delete, if multiple targets are affected.
*/
export interface Schema$DocumentRemove {
/**
* The resource name of the Document that has gone out of view.
*/
document?: string | null;
/**
* The read timestamp at which the remove was observed. Greater or equal to the `commit_time` of the change/delete/remove.
*/
readTime?: string | null;
/**
* A set of target IDs for targets that previously matched this document.
*/
removedTargetIds?: number[] | null;
}
/**
* A target specified by a set of documents names.
*/
export interface Schema$DocumentsTarget {
/**
* The names of the documents to retrieve. In the format: `projects/{project_id\}/databases/{database_id\}/documents/{document_path\}`. The request will fail if any of the document is not a child resource of the given `database`. Duplicate names will be elided.
*/
documents?: string[] | null;
}
/**
* A transformation of a document.
*/
export interface Schema$DocumentTransform {
/**
* The name of the document to transform.
*/
document?: string | null;
/**
* The list of transformations to apply to the fields of the document, in order. This must not be empty.
*/
fieldTransforms?: Schema$FieldTransform[];
}
/**
* A generic empty message that you can re-use to avoid defining duplicated empty messages in your APIs. A typical example is to use it as the request or the response type of an API method. For instance: service Foo { rpc Bar(google.protobuf.Empty) returns (google.protobuf.Empty); \}
*/
export interface Schema$Empty {
}
/**
* The request for Firestore.ExecutePipeline.
*/
export interface Schema$ExecutePipelineRequest {
/**
* Execute the pipeline in a new transaction. The identifier of the newly created transaction will be returned in the first response on the stream. This defaults to a read-only transaction.
*/
newTransaction?: Schema$TransactionOptions;
/**
* Execute the pipeline in a snapshot transaction at the given time. This must be a microsecond precision timestamp within the past one hour, or if Point-in-Time Recovery is enabled, can additionally be a whole minute timestamp within the past 7 days.
*/
readTime?: string | null;
/**
* A pipelined operation.
*/
structuredPipeline?: Schema$StructuredPipeline;
/**
* Run the query within an already active transaction. The value here is the opaque transaction ID to execute the query in.
*/
transaction?: string | null;
}
/**
* The response for Firestore.Execute.
*/
export interface Schema$ExecutePipelineResponse {
/**
* The time at which the results are valid. This is a (not strictly) monotonically increasing value across multiple responses in the same stream. The API guarantees that all previously returned results are still valid at the latest `execution_time`. This allows the API consumer to treat the query if it ran at the latest `execution_time` returned. If the query returns no results, a response with `execution_time` and no `results` will be sent, and this represents the time at which the operation was run.
*/
executionTime?: string | null;
/**
* Query explain stats. This is present on the **last** response if the request configured explain to run in 'analyze' or 'explain' mode in the pipeline options. If the query does not return any results, a response with `explain_stats` and no `results` will still be sent.
*/
explainStats?: Schema$ExplainStats;
/**
* An ordered batch of results returned executing a pipeline. The batch size is variable, and can even be zero for when only a partial progress message is returned. The fields present in the returned documents are only those that were explicitly requested in the pipeline, this includes those like `__name__` and `__update_time__`. This is explicitly a divergence from `Firestore.RunQuery` / `Firestore.GetDocument` RPCs which always return such fields even when they are not specified in the `mask`.
*/
results?: Schema$Document[];
/**
* Newly created transaction identifier. This field is only specified as part of the first response from the server, alongside the `results` field when the original request specified ExecuteRequest.new_transaction.
*/
transaction?: string | null;
}
/**
* Execution statistics for the query.
*/
export interface Schema$ExecutionStats {
/**
* Debugging statistics from the execution of the query. Note that the debugging stats are subject to change as Firestore evolves. It could include: { "indexes_entries_scanned": "1000", "documents_scanned": "20", "billing_details" : { "documents_billable": "20", "index_entries_billable": "1000", "min_query_cost": "0" \} \}
*/
debugStats?: {
[key: string]: any;
} | null;
/**
* Total time to execute the query in the backend.
*/
executionDuration?: string | null;
/**
* Total billable read operations.
*/
readOperations?: string | null;
/**
* Total number of results returned, including documents, projections, aggregation results, keys.
*/
resultsReturned?: string | null;
}
/**
* A digest of all the documents that match a given target.
*/
export interface Schema$ExistenceFilter {
/**
* The total count of documents that match target_id. If different from the count of documents in the client that match, the client must manually determine which documents no longer match the target. The client can use the `unchanged_names` bloom filter to assist with this determination by testing ALL the document names against the filter; if the document name is NOT in the filter, it means the document no longer matches the target.
*/
count?: number | null;
/**
* The target ID to which this filter applies.
*/
targetId?: number | null;
/**
* A bloom filter that, despite its name, contains the UTF-8 byte encodings of the resource names of ALL the documents that match target_id, in the form `projects/{project_id\}/databases/{database_id\}/documents/{document_path\}`. This bloom filter may be omitted at the server's discretion, such as if it is deemed that the client will not make use of it or if it is too computationally expensive to calculate or transmit. Clients must gracefully handle this field being absent by falling back to the logic used before this field existed; that is, re-add the target without a resume token to figure out which documents in the client's cache are out of sync.
*/
unchangedNames?: Schema$BloomFilter;
}
/**
* Explain metrics for the query.
*/
export interface Schema$ExplainMetrics {
/**
* Aggregated stats from the execution of the query. Only present when ExplainOptions.analyze is set to true.
*/
executionStats?: Schema$ExecutionStats;
/**
* Planning phase information for the query.
*/
planSummary?: Schema$PlanSummary;
}
/**
* Explain options for the query.
*/
export interface Schema$ExplainOptions {
/**
* Optional. Whether to execute this query. When false (the default), the query will be planned, returning only metrics from the planning stages. When true, the query will be planned and executed, returning the full query results along with both planning and execution stage metrics.
*/
analyze?: boolean | null;
}
/**
* Pipeline explain stats. Depending on the explain options in the original request, this can contain the optimized plan and / or execution stats.
*/
export interface Schema$ExplainStats {
/**
* The format depends on the `output_format` options in the request. Currently there are two supported options: `TEXT` and `JSON`. Both supply a `google.protobuf.StringValue`.
*/
data?: {
[key: string]: any;
} | null;
}
/**
* A filter on a specific field.
*/
export interface Schema$FieldFilter {
/**
* The field to filter by.
*/
field?: Schema$FieldReference;
/**
* The operator to filter by.
*/
op?: string | null;
/**
* The value to compare to.
*/
value?: Schema$Value;
}
/**
* A reference to a field in a document, ex: `stats.operations`.
*/
export interface Schema$FieldReference {
/**
* A reference to a field in a document. Requires: * MUST be a dot-delimited (`.`) string of segments, where each segment conforms to document field name limitations.
*/
fieldPath?: string | null;
}
/**
* A transformation of a field of the document.
*/
export interface Schema$FieldTransform {
/**
* Append the given elements in order if they are not already present in the current field value. If the field is not an array, or if the field does not yet exist, it is first set to the empty array. Equivalent numbers of different types (e.g. 3L and 3.0) are considered equal when checking if a value is missing. NaN is equal to NaN, and Null is equal to Null. If the input contains multiple equivalent values, only the first will be considered. The corresponding transform_result will be the null value.
*/
appendMissingElements?: Schema$ArrayValue;
/**
* The path of the field. See Document.fields for the field path syntax reference.
*/
fieldPath?: string | null;
/**
* Adds the given value to the field's current value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If either of the given value or the current field value are doubles, both values will be interpreted as doubles. Double arithmetic and representation of double values follow IEEE 754 semantics. If there is positive/negative integer overflow, the field is resolved to the largest magnitude positive/negative integer.
*/
increment?: Schema$Value;
/**
* Sets the field to the maximum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the given value. If a maximum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the larger operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The maximum of a zero stored value and zero input value is always the stored value. The maximum of any numeric value x and NaN is NaN.
*/
maximum?: Schema$Value;
/**
* Sets the field to the minimum of its current value and the given value. This must be an integer or a double value. If the field is not an integer or double, or if the field does not yet exist, the transformation will set the field to the input value. If a minimum operation is applied where the field and the input value are of mixed types (that is - one is an integer and one is a double) the field takes on the type of the smaller operand. If the operands are equivalent (e.g. 3 and 3.0), the field does not change. 0, 0.0, and -0.0 are all zero. The minimum of a zero stored value and zero input value is always the stored value. The minimum of any numeric value x and NaN is NaN.
*/
minimum?: Schema$Value;
/**
* Remove all of the given elements from the array in the field. If the field is not an array, or if the field does not yet exist, it is set to the empty array. Equivalent numbers of the different types (e.g. 3L and 3.0) are considered equal when deciding whether an element should be removed. NaN is equal to NaN, and Null is equal to Null. This will remove all equivalent values if there are duplicates. The corresponding transform_result will be the null value.
*/
removeAllFromArray?: Schema$ArrayValue;
/**
* Sets the field to the given server value.
*/
setToServerValue?: string | null;
}
/**
* A filter.
*/
export interface Schema$Filter {
/**
* A composite filter.
*/
compositeFilter?: Schema$CompositeFilter;
/**
* A filter on a document field.
*/
fieldFilter?: Schema$FieldFilter;
/**
* A filter that takes exactly one argument.
*/
unaryFilter?: Schema$UnaryFilter;
}
/**
* Nearest Neighbors search config. The ordering provided by FindNearest supersedes the order_by stage. If multiple documents have the same vector distance, the returned document order is not guaranteed to be stable between queries.
*/
export interface Schema$FindNearest {
/**
* Required. The distance measure to use, required.
*/
distanceMeasure?: string | null;
/**
* Optional. Optional name of the field to output the result of the vector distance calculation. Must conform to document field name limitations.
*/
distanceResultField?: string | null;
/**
* Optional. Option to specify a threshold for which no less similar documents will be returned. The behavior of the specified `distance_measure` will affect the meaning of the distance threshold. Since DOT_PRODUCT distances increase when the vectors are more similar, the comparison is inverted. * For EUCLIDEAN, COSINE: `WHERE distance <= distance_threshold` * For DOT_PRODUCT: `WHERE distance \>= distance_threshold`
*/
distanceThreshold?: number | null;
/**
* Required. The number of nearest neighbors to return. Must be a positive integer of no more than 1000.
*/
limit?: number | null;
/**
* Required. The query vector that we are searching on. Must be a vector of no more than 2048 dimensions.
*/
queryVector?: Schema$Value;
/**
* Required. An indexed vector field to search upon. Only documents which contain vectors whose dimensionality match the query_vector can be returned.
*/
vectorField?: Schema$FieldReference;
}
/**
* Represents an unevaluated scalar expression. For example, the expression `like(user_name, "%alice%")` is represented as: ``` name: "like" args { field_reference: "user_name" \} args { string_value: "%alice%" \} ```
*/
export interface Schema$Function {
/**
* Optional. Ordered list of arguments the given function expects.
*/
args?: Schema$Value[];
/**
* Required. The name of the function to evaluate. **Requires:** * must be in snake case (lower case with underscore separator).
*/
name?: string | null;
/**
* Optional. Optional named arguments that certain functions may support.
*/
options?: {
[key: string]: Schema$Value;
} | null;
}
/**
* A Backup of a Cloud Firestore Database. The backup contains all documents and index configurations for the given database at a specific point in time.
*/
export interface Schema$GoogleFirestoreAdminV1Backup {
/**
* Output only. Name of the Firestore database that the backup is from. Format is `projects/{project\}/databases/{database\}`.
*/
database?: string | null;
/**
* Output only. The system-generated UUID4 for the Firestore database that the backup is from.
*/
databaseUid?: string | null;
/**
* Output only. The timestamp at which this backup expires.
*/
expireTime?: string | null;
/**
* Output only. The unique resource name of the Backup. Format is `projects/{project\}/locations/{location\}/backups/{backup\}`.
*/
name?: string | null;
/**
* Output only. The backup contains an externally consistent copy of the database at this time.
*/
snapshotTime?: string | null;
/**
* Output only. The current state of the backup.
*/
state?: string | null;
/**
* Output only. Statistics about the backup. This data only becomes available after the backup is fully materialized to secondary storage. This field will be empty till then.
*/
stats?: Schema$GoogleFirestoreAdminV1Stats;
}
/**
* A backup schedule for a Cloud Firestore Database. This resource is owned by the database it is backing up, and is deleted along with the database. The actual backups are not though.
*/
export interface Schema$GoogleFirestoreAdminV1BackupSchedule {
/**
* Output only. The timestamp at which this backup schedule was created and effective since. No backups will be created for this schedule before this time.
*/
createTime?: string | null;
/**
* For a schedule that runs daily.
*/
dailyRecurrence?: Schema$GoogleFirestoreAdminV1DailyRecurrence;
/**
* Output only. The unique backup schedule identifier across all locations and databases for the given project. This will be auto-assigned. Format is `projects/{project\}/databases/{database\}/backupSchedules/{backup_schedule\}`
*/
name?: string | null;
/**
* At what relative time in the future, compared to its creation time, the backup should be deleted, e.g. keep backups for 7 days. The maximum supported retention period is 14 weeks.
*/
retention?: string | null;
/**
* Output only. The timestamp at which this backup schedule was most recently updated. When a backup schedule is first created, this is the same as create_time.
*/
updateTime?: string | null;
/**
* For a schedule that runs weekly on a specific day.
*/
weeklyRecurrence?: Schema$GoogleFirestoreAdminV1WeeklyRecurrence;
}
/**
* Information about a backup that was used to restore a database.
*/
export interface Schema$GoogleFirestoreAdminV1BackupSource {
/**
* The resource name of the backup that was used to restore this database. Format: `projects/{project\}/locations/{location\}/backups/{backup\}`.
*/
backup?: string | null;
}
/**
* Metadata for google.longrunning.Operation results from FirestoreAdmin.BulkDeleteDocuments.
*/
export interface Schema$GoogleFirestoreAdminV1BulkDeleteDocumentsMetadata {
/**
* The IDs of the collection groups that are being deleted.
*/
collectionIds?: string[] | null;
/**
* The time this operation completed. Will be unset if operation still in progress.
*/
endTime?: string | null;
/**
* Which namespace IDs are being deleted.
*/
namespaceIds?: string[] | null;
/**
* The state of the operation.
*/
operationState?: string | null;
/**
* The progress, in bytes, of this operation.
*/
progressBytes?: Schema$GoogleFirestoreAdminV1Progress;
/**
* The progress, in documents, of this operation.
*/
progressDocuments?: Schema$GoogleFirestoreAdminV1Progress;
/**
* The timestamp that corresponds to the version of the database that is being read to get the list of documents to delete. This time can also be used as the timestamp of PITR in case of disaster recovery (subject to PITR window limit).
*/
snapshotTime?: string | null;
/**
* The time this operation started.
*/
startTime?: string | null;
}
/**
* The request for FirestoreAdmin.BulkDeleteDocuments. When both collection_ids and namespace_ids are set, only documents satisfying both conditions will be deleted. Requests with namespace_ids and collection_ids both empty will be rejected. Please use FirestoreAdmin.DeleteDatabase instead.
*/
export interface Schema$GoogleFirestoreAdminV1BulkDeleteDocumentsRequest {
/**
* Optional. IDs of the collection groups to delete. Unspecified means all collection groups. Each collection group in this list must be unique.
*/
collectionIds?: string[] | null;
/**
* Optional. Namespaces to delete. An empty list means all namespaces. This is the recommended usage for databases that don't use namespaces. An empty string element represents the default namespace. This should be used if the database has data in non-default namespaces, but doesn't want to delete from them. Each namespace in this list must be unique.
*/
namespaceIds?: string[] | null;
}
/**
* Metadata for the long-running operation from the CloneDatabase request.
*/
export interface Schema$GoogleFirestoreAdminV1CloneDatabaseMetadata {
/**
* The name of the database being cloned to.
*/
database?: string | null;
/**
* The time the clone finished, unset for ongoing clones.
*/
endTime?: string | null;
/**
* The operation state of the clone.
*/
operationState?: string | null;
/**
* The snapshot from which this database was cloned.
*/
pitrSnapshot?: Schema$GoogleFirestoreAdminV1PitrSnapshot;
/**
* How far along the clone is as an estimated percentage of remaining time.
*/
progressPercentage?: Schema$GoogleFirestoreAdminV1Progress;
/**
* The time the clone was started.
*/
startTime?: string | null;
}
/**
* The request message for FirestoreAdmin.CloneDatabase.
*/
export interface Schema$GoogleFirestoreAdminV1CloneDatabaseRequest {
/**
* Required. The ID to use for the database, which will become the final component of the database's resource name. This database ID must not be associated with an existing database. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8\}(-[0-9a-f]{4\}){3\}-[0-9a-f]{12\}/. "(default)" database ID is also valid if the database is Standard edition.
*/
databaseId?: string | null;
/**
* Optional. Encryption configuration for the cloned database. If this field is not specified, the cloned database will use the same encryption configuration as the source database, namely use_source_encryption.
*/
encryptionConfig?: Schema$GoogleFirestoreAdminV1EncryptionConfig;
/**
* Required. Specification of the PITR data to clone from. The source database must exist. The cloned database will be created in the same location as the source database.
*/
pitrSnapshot?: Schema$GoogleFirestoreAdminV1PitrSnapshot;
/**
* Optional. Immutable. Tags to be bound to the cloned database. The tags should be provided in the format of `tagKeys/{tag_key_id\} -\> tagValues/{tag_value_id\}`.
*/
tags?: {
[key: string]: string;
} | null;
}
/**
* The CMEK (Customer Managed Encryption Key) configuration for a Firestore database. If not present, the database is secured by the default Google encryption key.
*/
export interface Schema$GoogleFirestoreAdminV1CmekConfig {
/**
* Output only. Currently in-use [KMS key versions](https://cloud.google.com/kms/docs/resource-hierarchy#key_versions). During [key rotation](https://cloud.google.com/kms/docs/key-rotation), there can be multiple in-use key versions. The expected format is `projects/{project_id\}/locations/{kms_location\}/keyRings/{key_ring\}/cryptoKeys/{crypto_key\}/cryptoKeyVersions/{key_version\}`.
*/
activeKeyVersion?: string[] | null;
/**
* Required. Only keys in the same location as this database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is `projects/{project_id\}/locations/{kms_location\}/keyRings/{key_ring\}/cryptoKeys/{crypto_key\}`.
*/
kmsKeyName?: string | null;
}
/**
* Metadata related to the create database operation.
*/
export interface Schema$GoogleFirestoreAdminV1CreateDatabaseMetadata {
}
/**
* The configuration options for using CMEK (Customer Managed Encryption Key) encryption.
*/
export interface Schema$GoogleFirestoreAdminV1CustomerManagedEncryptionOptions {
/**
* Required. Only keys in the same location as the database are allowed to be used for encryption. For Firestore's nam5 multi-region, this corresponds to Cloud KMS multi-region us. For Firestore's eur3 multi-region, this corresponds to Cloud KMS multi-region europe. See https://cloud.google.com/kms/docs/locations. The expected format is `projects/{project_id\}/locations/{kms_location\}/keyRings/{key_ring\}/cryptoKeys/{crypto_key\}`.
*/
kmsKeyName?: string | null;
}
/**
* Represents a recurring schedule that runs every day. The time zone is UTC.
*/
export interface Schema$GoogleFirestoreAdminV1DailyRecurrence {
}
/**
* A Cloud Firestore Database.
*/
export interface Schema$GoogleFirestoreAdminV1Database {
/**
* The App Engine integration mode to use for this database.
*/
appEngineIntegrationMode?: string | null;
/**
* Optional. Presence indicates CMEK is enabled for this database.
*/
cmekConfig?: Schema$GoogleFirestoreAdminV1CmekConfig;
/**
* The concurrency control mode to use for this database. If unspecified in a CreateDatabase request, this will default based on the database edition: Optimistic for Enterprise and Pessimistic for all other databases.
*/
concurrencyMode?: string | null;
/**
* Output only. The timestamp at which this database was created. Databases created before 2016 do not populate create_time.
*/
createTime?: string | null;
/**
* Immutable. The edition of the database.
*/
databaseEdition?: string | null;
/**
* State of delete protection for the database.
*/
deleteProtectionState?: string | null;
/**
* Output only. The timestamp at which this database was deleted. Only set if the database has been deleted.
*/
deleteTime?: string | null;
/**
* Output only. The earliest timestamp at which older versions of the data can be read from the database. See [version_retention_period] above; this field is populated with `now - version_retention_period`. This value is continuously updated, and becomes stale the moment it is queried. If you are using this value to recover data, make sure to account for the time from the moment when the value is queried to the moment when you initiate the recovery.
*/
earliestVersionTime?: string | null;
/**
* This checksum is computed by the server based on the value of other fields, and may be sent on update and delete requests to ensure the client has an up-to-date value before proceeding.
*/
etag?: string | null;
/**
* Optional. The Firestore API data access mode to use for this database. If not set on write: - the default value is DATA_ACCESS_MODE_DISABLED for Enterprise Edition. - the default value is DATA_ACCESS_MODE_ENABLED for Standard Edition.
*/
firestoreDataAccessMode?: string | null;
/**
* Output only. Background: Free tier is the ability of a Firestore database to use a small amount of resources every day without being charged. Once usage exceeds the free tier limit further usage is charged. Whether this database can make use of the free tier. Only one database per project can be eligible for the free tier. The first (or next) database that is created in a project without a free tier database will be marked as eligible for the free tier. Databases that are created while there is a free tier database will not be eligible for the free tier.
*/
freeTier?: boolean | null;
/**
* Output only. The key_prefix for this database. This key_prefix is used, in combination with the project ID ("~") to construct the application ID that is returned from the Cloud Datastore APIs in Google App Engine first generation runtimes. This value may be empty in which case the appid to use for URL-encoded keys is the project_id (eg: foo instead of v~foo).
*/
keyPrefix?: string | null;
/**
* The location of the database. Available locations are listed at https://cloud.google.com/firestore/docs/locations.
*/
locationId?: string | null;
/**
* Optional. The MongoDB compatible API data access mode to use for this database. If not set on write, the default value is DATA_ACCESS_MODE_ENABLED for Enterprise Edition. The value is always DATA_ACCESS_MODE_DISABLED for Standard Edition.
*/
mongodbCompatibleDataAccessMode?: string | null;
/**
* The resource name of the Database. Format: `projects/{project\}/databases/{database\}`
*/
name?: string | null;
/**
* Whether to enable the PITR feature on this database.
*/
pointInTimeRecoveryEnablement?: string | null;
/**
* Output only. The database resource's prior database ID. This field is only populated for deleted databases.
*/
previousId?: string | null;
/**
* Immutable. The default Realtime Updates mode to use for this database.
*/
realtimeUpdatesMode?: string | null;
/**
* Output only. Information about the provenance of this database.
*/
sourceInfo?: Schema$GoogleFirestoreAdminV1SourceInfo;
/**
* Optional. Input only. Immutable. Tag keys/values directly bound to this resource. For example: "123/environment": "production", "123/costCenter": "marketing"
*/
tags?: {
[key: string]: string;
} | null;
/**
* The type of the database. See https://cloud.google.com/datastore/docs/firestore-or-datastore for information about how to choose.
*/
type?: string | null;
/**
* Output only. The system-generated UUID4 for this Database.
*/
uid?: string | null;
/**
* Output only. The timestamp at wh