OMGeeky/google-apis-rs
1
0
Fork 0
mirror of https://github.com/OMGeeky/google-apis-rs.git synced 2026-02-23 15:49:49 +01:00
Code Issues Packages Projects Releases Wiki Activity
Files
37ba635de2b0340299e6a35431c2efd0ca3aa555
google-apis-rs/google_firestore1_beta1/api/index.html
Sebastian Thiel 37ba635de2 Update documentation
2021-04-02 00:20:57 +08:00

94 lines
30 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `api` mod in crate `google_firestore1_beta1`."><meta name="keywords" content="rust, rustlang, rust-lang, api"><title>google_firestore1_beta1::api - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css" disabled ><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled ><script id="default-settings"></script><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" type="image/svg+xml" href="../../favicon.svg">
<link rel="alternate icon" type="image/png" href="../../favicon-16x16.png">
<link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../google_firestore1_beta1/index.html'><div class='logo-container rust-logo'><img src='../../rust-logo.png' alt='logo'></div></a><p class="location">Module api</p><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></div><p class="location"><a href="../index.html">google_firestore1_beta1</a></p><div id="sidebar-vars" data-name="api" data-ty="mod" data-relpath="../"></div><script defer src="../sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices" role="menu"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" disabled autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" class="help-button">?</button>
<a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class="fqn"><span class="in-band">Module <a href="../index.html">google_firestore1_beta1</a>::<wbr><a class="mod" href="">api</a></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span><a class="srclink" href="../../src/google_firestore1_beta1/api.rs.html#1-8215" title="goto source code">[src]</a></span></h1><h2 id="structs" class="section-header"><a href="#structs">Structs</a></h2>
<table><tr class="module-item"><td><a class="struct" href="struct.ArrayValue.html" title="google_firestore1_beta1::api::ArrayValue struct">ArrayValue</a></td><td class="docblock-short"><p>An array value.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BatchGetDocumentsRequest.html" title="google_firestore1_beta1::api::BatchGetDocumentsRequest struct">BatchGetDocumentsRequest</a></td><td class="docblock-short"><p>The request for Firestore.BatchGetDocuments.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BatchGetDocumentsResponse.html" title="google_firestore1_beta1::api::BatchGetDocumentsResponse struct">BatchGetDocumentsResponse</a></td><td class="docblock-short"><p>The streamed response for Firestore.BatchGetDocuments.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BatchWriteRequest.html" title="google_firestore1_beta1::api::BatchWriteRequest struct">BatchWriteRequest</a></td><td class="docblock-short"><p>The request for Firestore.BatchWrite.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BatchWriteResponse.html" title="google_firestore1_beta1::api::BatchWriteResponse struct">BatchWriteResponse</a></td><td class="docblock-short"><p>The response from Firestore.BatchWrite.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BeginTransactionRequest.html" title="google_firestore1_beta1::api::BeginTransactionRequest struct">BeginTransactionRequest</a></td><td class="docblock-short"><p>The request for Firestore.BeginTransaction.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.BeginTransactionResponse.html" title="google_firestore1_beta1::api::BeginTransactionResponse struct">BeginTransactionResponse</a></td><td class="docblock-short"><p>The response for Firestore.BeginTransaction.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CollectionSelector.html" title="google_firestore1_beta1::api::CollectionSelector struct">CollectionSelector</a></td><td class="docblock-short"><p>A selection of a collection, such as <code>messages as m1</code>.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CommitRequest.html" title="google_firestore1_beta1::api::CommitRequest struct">CommitRequest</a></td><td class="docblock-short"><p>The request for Firestore.Commit.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CommitResponse.html" title="google_firestore1_beta1::api::CommitResponse struct">CommitResponse</a></td><td class="docblock-short"><p>The response for Firestore.Commit.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.CompositeFilter.html" title="google_firestore1_beta1::api::CompositeFilter struct">CompositeFilter</a></td><td class="docblock-short"><p>A filter that merges multiple other filters using the given operator.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Cursor.html" title="google_firestore1_beta1::api::Cursor struct">Cursor</a></td><td class="docblock-short"><p>A position in a query result set.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Document.html" title="google_firestore1_beta1::api::Document struct">Document</a></td><td class="docblock-short"><p>A Firestore document. Must not exceed 1 MiB - 4 bytes.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DocumentChange.html" title="google_firestore1_beta1::api::DocumentChange struct">DocumentChange</a></td><td class="docblock-short"><p>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.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DocumentDelete.html" title="google_firestore1_beta1::api::DocumentDelete struct">DocumentDelete</a></td><td class="docblock-short"><p>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.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DocumentMask.html" title="google_firestore1_beta1::api::DocumentMask struct">DocumentMask</a></td><td class="docblock-short"><p>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.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DocumentRemove.html" title="google_firestore1_beta1::api::DocumentRemove struct">DocumentRemove</a></td><td class="docblock-short"><p>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.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DocumentTransform.html" title="google_firestore1_beta1::api::DocumentTransform struct">DocumentTransform</a></td><td class="docblock-short"><p>A transformation of a document.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.DocumentsTarget.html" title="google_firestore1_beta1::api::DocumentsTarget struct">DocumentsTarget</a></td><td class="docblock-short"><p>A target specified by a set of documents names.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Empty.html" title="google_firestore1_beta1::api::Empty struct">Empty</a></td><td class="docblock-short"><p>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); } The JSON representation for <code>Empty</code> is empty JSON object <code>{}</code>.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ExistenceFilter.html" title="google_firestore1_beta1::api::ExistenceFilter struct">ExistenceFilter</a></td><td class="docblock-short"><p>A digest of all the documents that match a given target.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FieldFilter.html" title="google_firestore1_beta1::api::FieldFilter struct">FieldFilter</a></td><td class="docblock-short"><p>A filter on a specific field.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FieldReference.html" title="google_firestore1_beta1::api::FieldReference struct">FieldReference</a></td><td class="docblock-short"><p>A reference to a field, such as <code>max(messages.time) as max_time</code>.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.FieldTransform.html" title="google_firestore1_beta1::api::FieldTransform struct">FieldTransform</a></td><td class="docblock-short"><p>A transformation of a field of the document.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Filter.html" title="google_firestore1_beta1::api::Filter struct">Filter</a></td><td class="docblock-short"><p>A filter.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Firestore.html" title="google_firestore1_beta1::api::Firestore struct">Firestore</a></td><td class="docblock-short"><p>Central instance to access all Firestore related resource activities</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleFirestoreAdminV1beta1ExportDocumentsRequest.html" title="google_firestore1_beta1::api::GoogleFirestoreAdminV1beta1ExportDocumentsRequest struct">GoogleFirestoreAdminV1beta1ExportDocumentsRequest</a></td><td class="docblock-short"><p>The request for FirestoreAdmin.ExportDocuments.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleFirestoreAdminV1beta1ImportDocumentsRequest.html" title="google_firestore1_beta1::api::GoogleFirestoreAdminV1beta1ImportDocumentsRequest struct">GoogleFirestoreAdminV1beta1ImportDocumentsRequest</a></td><td class="docblock-short"><p>The request for FirestoreAdmin.ImportDocuments.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleFirestoreAdminV1beta1Index.html" title="google_firestore1_beta1::api::GoogleFirestoreAdminV1beta1Index struct">GoogleFirestoreAdminV1beta1Index</a></td><td class="docblock-short"><p>An index definition.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleFirestoreAdminV1beta1IndexField.html" title="google_firestore1_beta1::api::GoogleFirestoreAdminV1beta1IndexField struct">GoogleFirestoreAdminV1beta1IndexField</a></td><td class="docblock-short"><p>A field of an index.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleFirestoreAdminV1beta1ListIndexesResponse.html" title="google_firestore1_beta1::api::GoogleFirestoreAdminV1beta1ListIndexesResponse struct">GoogleFirestoreAdminV1beta1ListIndexesResponse</a></td><td class="docblock-short"><p>The response for FirestoreAdmin.ListIndexes.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.GoogleLongrunningOperation.html" title="google_firestore1_beta1::api::GoogleLongrunningOperation struct">GoogleLongrunningOperation</a></td><td class="docblock-short"><p>This resource represents a long-running operation that is the result of a network API call.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.LatLng.html" title="google_firestore1_beta1::api::LatLng struct">LatLng</a></td><td class="docblock-short"><p>An object that represents a latitude/longitude pair. This is expressed as a pair of doubles to represent degrees latitude and degrees longitude. Unless specified otherwise, this must conform to the WGS84 standard. Values must be within normalized ranges.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListCollectionIdsRequest.html" title="google_firestore1_beta1::api::ListCollectionIdsRequest struct">ListCollectionIdsRequest</a></td><td class="docblock-short"><p>The request for Firestore.ListCollectionIds.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListCollectionIdsResponse.html" title="google_firestore1_beta1::api::ListCollectionIdsResponse struct">ListCollectionIdsResponse</a></td><td class="docblock-short"><p>The response from Firestore.ListCollectionIds.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListDocumentsResponse.html" title="google_firestore1_beta1::api::ListDocumentsResponse struct">ListDocumentsResponse</a></td><td class="docblock-short"><p>The response for Firestore.ListDocuments.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListenRequest.html" title="google_firestore1_beta1::api::ListenRequest struct">ListenRequest</a></td><td class="docblock-short"><p>A request for Firestore.Listen</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ListenResponse.html" title="google_firestore1_beta1::api::ListenResponse struct">ListenResponse</a></td><td class="docblock-short"><p>The response for Firestore.Listen.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.MapValue.html" title="google_firestore1_beta1::api::MapValue struct">MapValue</a></td><td class="docblock-short"><p>A map value.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Order.html" title="google_firestore1_beta1::api::Order struct">Order</a></td><td class="docblock-short"><p>An order on a field.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PartitionQueryRequest.html" title="google_firestore1_beta1::api::PartitionQueryRequest struct">PartitionQueryRequest</a></td><td class="docblock-short"><p>The request for Firestore.PartitionQuery.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.PartitionQueryResponse.html" title="google_firestore1_beta1::api::PartitionQueryResponse struct">PartitionQueryResponse</a></td><td class="docblock-short"><p>The response for Firestore.PartitionQuery.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Precondition.html" title="google_firestore1_beta1::api::Precondition struct">Precondition</a></td><td class="docblock-short"><p>A precondition on a document, used for conditional operations.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDatabaseDocumentBatchGetCall.html" title="google_firestore1_beta1::api::ProjectDatabaseDocumentBatchGetCall struct">ProjectDatabaseDocumentBatchGetCall</a></td><td class="docblock-short"><p>Gets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDatabaseDocumentBatchWriteCall.html" title="google_firestore1_beta1::api::ProjectDatabaseDocumentBatchWriteCall struct">ProjectDatabaseDocumentBatchWriteCall</a></td><td class="docblock-short"><p>Applies a batch of write operations. The BatchWrite method does not apply the write operations atomically and can apply them out of order. Method does not allow more than one write per document. Each write succeeds or fails independently. See the BatchWriteResponse for the success status of each write. If you require an atomically applied set of writes, use Commit instead.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDatabaseDocumentBeginTransactionCall.html" title="google_firestore1_beta1::api::ProjectDatabaseDocumentBeginTransactionCall struct">ProjectDatabaseDocumentBeginTransactionCall</a></td><td class="docblock-short"><p>Starts a new transaction.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDatabaseDocumentCommitCall.html" title="google_firestore1_beta1::api::ProjectDatabaseDocumentCommitCall struct">ProjectDatabaseDocumentCommitCall</a></td><td class="docblock-short"><p>Commits a transaction, while optionally updating documents.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDatabaseDocumentCreateDocumentCall.html" title="google_firestore1_beta1::api::ProjectDatabaseDocumentCreateDocumentCall struct">ProjectDatabaseDocumentCreateDocumentCall</a></td><td class="docblock-short"><p>Creates a new document.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDatabaseDocumentDeleteCall.html" title="google_firestore1_beta1::api::ProjectDatabaseDocumentDeleteCall struct">ProjectDatabaseDocumentDeleteCall</a></td><td class="docblock-short"><p>Deletes a document.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDatabaseDocumentGetCall.html" title="google_firestore1_beta1::api::ProjectDatabaseDocumentGetCall struct">ProjectDatabaseDocumentGetCall</a></td><td class="docblock-short"><p>Gets a single document.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDatabaseDocumentListCall.html" title="google_firestore1_beta1::api::ProjectDatabaseDocumentListCall struct">ProjectDatabaseDocumentListCall</a></td><td class="docblock-short"><p>Lists documents.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDatabaseDocumentListCollectionIdCall.html" title="google_firestore1_beta1::api::ProjectDatabaseDocumentListCollectionIdCall struct">ProjectDatabaseDocumentListCollectionIdCall</a></td><td class="docblock-short"><p>Lists all the collection IDs underneath a document.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDatabaseDocumentListenCall.html" title="google_firestore1_beta1::api::ProjectDatabaseDocumentListenCall struct">ProjectDatabaseDocumentListenCall</a></td><td class="docblock-short"><p>Listens to changes.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDatabaseDocumentPartitionQueryCall.html" title="google_firestore1_beta1::api::ProjectDatabaseDocumentPartitionQueryCall struct">ProjectDatabaseDocumentPartitionQueryCall</a></td><td class="docblock-short"><p>Partitions a query by returning partition cursors that can be used to run the query in parallel. The returned partition cursors are split points that can be used by RunQuery as starting/end points for the query results.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDatabaseDocumentPatchCall.html" title="google_firestore1_beta1::api::ProjectDatabaseDocumentPatchCall struct">ProjectDatabaseDocumentPatchCall</a></td><td class="docblock-short"><p>Updates or inserts a document.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDatabaseDocumentRollbackCall.html" title="google_firestore1_beta1::api::ProjectDatabaseDocumentRollbackCall struct">ProjectDatabaseDocumentRollbackCall</a></td><td class="docblock-short"><p>Rolls back a transaction.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDatabaseDocumentRunQueryCall.html" title="google_firestore1_beta1::api::ProjectDatabaseDocumentRunQueryCall struct">ProjectDatabaseDocumentRunQueryCall</a></td><td class="docblock-short"><p>Runs a query.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDatabaseDocumentWriteCall.html" title="google_firestore1_beta1::api::ProjectDatabaseDocumentWriteCall struct">ProjectDatabaseDocumentWriteCall</a></td><td class="docblock-short"><p>Streams batches of document updates and deletes, in order.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDatabaseExportDocumentCall.html" title="google_firestore1_beta1::api::ProjectDatabaseExportDocumentCall struct">ProjectDatabaseExportDocumentCall</a></td><td class="docblock-short"><p>Exports a copy of all or a subset of documents from Google Cloud Firestore to another storage system, such as Google Cloud Storage. Recent updates to documents may not be reflected in the export. The export occurs in the background and its progress can be monitored and managed via the Operation resource that is created. The output of an export may only be used once the associated operation is done. If an export operation is cancelled before completion it may leave partial data behind in Google Cloud Storage.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDatabaseImportDocumentCall.html" title="google_firestore1_beta1::api::ProjectDatabaseImportDocumentCall struct">ProjectDatabaseImportDocumentCall</a></td><td class="docblock-short"><p>Imports documents into Google Cloud Firestore. Existing documents with the same name are overwritten. The import occurs in the background and its progress can be monitored and managed via the Operation resource that is created. If an ImportDocuments operation is cancelled, it is possible that a subset of the data has already been imported to Cloud Firestore.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDatabaseIndexeCreateCall.html" title="google_firestore1_beta1::api::ProjectDatabaseIndexeCreateCall struct">ProjectDatabaseIndexeCreateCall</a></td><td class="docblock-short"><p>Creates the specified index. A newly created index's initial state is <code>CREATING</code>. On completion of the returned google.longrunning.Operation, the state will be <code>READY</code>. If the index already exists, the call will return an <code>ALREADY_EXISTS</code> status. During creation, the process could result in an error, in which case the index will move to the <code>ERROR</code> state. The process can be recovered by fixing the data that caused the error, removing the index with delete, then re-creating the index with create. Indexes with a single field cannot be created.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDatabaseIndexeDeleteCall.html" title="google_firestore1_beta1::api::ProjectDatabaseIndexeDeleteCall struct">ProjectDatabaseIndexeDeleteCall</a></td><td class="docblock-short"><p>Deletes an index.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDatabaseIndexeGetCall.html" title="google_firestore1_beta1::api::ProjectDatabaseIndexeGetCall struct">ProjectDatabaseIndexeGetCall</a></td><td class="docblock-short"><p>Gets an index.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectDatabaseIndexeListCall.html" title="google_firestore1_beta1::api::ProjectDatabaseIndexeListCall struct">ProjectDatabaseIndexeListCall</a></td><td class="docblock-short"><p>Lists the indexes that match the specified filters.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ProjectMethods.html" title="google_firestore1_beta1::api::ProjectMethods struct">ProjectMethods</a></td><td class="docblock-short"><p>A builder providing access to all methods supported on <em>project</em> resources.
It is not used directly, but through the <code>Firestore</code> hub.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Projection.html" title="google_firestore1_beta1::api::Projection struct">Projection</a></td><td class="docblock-short"><p>The projection of document's fields to return.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.QueryTarget.html" title="google_firestore1_beta1::api::QueryTarget struct">QueryTarget</a></td><td class="docblock-short"><p>A target specified by a query.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ReadOnly.html" title="google_firestore1_beta1::api::ReadOnly struct">ReadOnly</a></td><td class="docblock-short"><p>Options for a transaction that can only be used to read documents.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.ReadWrite.html" title="google_firestore1_beta1::api::ReadWrite struct">ReadWrite</a></td><td class="docblock-short"><p>Options for a transaction that can be used to read and write documents.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RollbackRequest.html" title="google_firestore1_beta1::api::RollbackRequest struct">RollbackRequest</a></td><td class="docblock-short"><p>The request for Firestore.Rollback.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RunQueryRequest.html" title="google_firestore1_beta1::api::RunQueryRequest struct">RunQueryRequest</a></td><td class="docblock-short"><p>The request for Firestore.RunQuery.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.RunQueryResponse.html" title="google_firestore1_beta1::api::RunQueryResponse struct">RunQueryResponse</a></td><td class="docblock-short"><p>The response for Firestore.RunQuery.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Status.html" title="google_firestore1_beta1::api::Status struct">Status</a></td><td class="docblock-short"><p>The <code>Status</code> type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by <a href="https://github.com/grpc">gRPC</a>. Each <code>Status</code> message contains three pieces of data: error code, error message, and error details. You can find out more about this error model and how to work with it in the <a href="https://cloud.google.com/apis/design/errors">API Design Guide</a>.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.StructuredQuery.html" title="google_firestore1_beta1::api::StructuredQuery struct">StructuredQuery</a></td><td class="docblock-short"><p>A Firestore query.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Target.html" title="google_firestore1_beta1::api::Target struct">Target</a></td><td class="docblock-short"><p>A specification of a set of documents to listen to.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TargetChange.html" title="google_firestore1_beta1::api::TargetChange struct">TargetChange</a></td><td class="docblock-short"><p>Targets being watched have changed.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.TransactionOptions.html" title="google_firestore1_beta1::api::TransactionOptions struct">TransactionOptions</a></td><td class="docblock-short"><p>Options for creating a new transaction.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.UnaryFilter.html" title="google_firestore1_beta1::api::UnaryFilter struct">UnaryFilter</a></td><td class="docblock-short"><p>A filter with a single operand.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Value.html" title="google_firestore1_beta1::api::Value struct">Value</a></td><td class="docblock-short"><p>A message that can hold any of the supported value types.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.Write.html" title="google_firestore1_beta1::api::Write struct">Write</a></td><td class="docblock-short"><p>A write on a document.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.WriteRequest.html" title="google_firestore1_beta1::api::WriteRequest struct">WriteRequest</a></td><td class="docblock-short"><p>The request for Firestore.Write. The first request creates a stream, or resumes an existing one from a token. When creating a new stream, the server replies with a response containing only an ID and a token, to use in the next request. When resuming a stream, the server first streams any responses later than the given token, then a response containing only an up-to-date token, to use in the next request.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.WriteResponse.html" title="google_firestore1_beta1::api::WriteResponse struct">WriteResponse</a></td><td class="docblock-short"><p>The response for Firestore.Write.</p>
</td></tr><tr class="module-item"><td><a class="struct" href="struct.WriteResult.html" title="google_firestore1_beta1::api::WriteResult struct">WriteResult</a></td><td class="docblock-short"><p>The result of applying a write.</p>
</td></tr></table><h2 id="enums" class="section-header"><a href="#enums">Enums</a></h2>
<table><tr class="module-item"><td><a class="enum" href="enum.Scope.html" title="google_firestore1_beta1::api::Scope enum">Scope</a></td><td class="docblock-short"><p>Identifies the an OAuth2 authorization scope.
A scope is needed when requesting an
<a href="https://developers.google.com/youtube/v3/guides/authentication">authorization token</a>.</p>
</td></tr></table></section><section id="search" class="content hidden"></section><section class="footer"></section><div id="rustdoc-vars" data-root-path="../../" data-current-crate="google_firestore1_beta1"></div>
<script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>
Reference in New Issue View Git Blame Copy Permalink