google_api_firestore v0.11.0 GoogleApi.Firestore.V1.Api.Projects View Source
API calls for all endpoints tagged Projects.
Link to this section Summary
Functions
Gets the metadata and configuration for a Field.
Lists the field configuration and metadata for this database.
Updates a field configuration. Currently, field updates apply only to
single field index configuration. However, calls to
FirestoreAdmin.UpdateField should provide a field mask to avoid
changing any configuration that the caller isn't aware of. The field mask
should be specified as: { paths: "index_config" }.
Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata.
Deletes a composite index.
Gets a composite index.
Lists composite indexes.
Gets multiple documents.
Starts a new transaction.
Commits a transaction, while optionally updating documents.
Creates a new document.
Deletes a document.
Gets a single document.
Lists documents.
Lists all the collection IDs underneath a document.
Listens to changes.
Updates or inserts a document.
Rolls back a transaction.
Runs a query.
Streams batches of document updates and deletes, in order.
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.
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.
Starts asynchronous cancellation on a long-running operation. The server
makes a best effort to cancel the operation, but success is not
guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Clients can use
Operations.GetOperation or
other methods to check whether the cancellation succeeded or whether the
operation completed despite cancellation. On successful cancellation,
the operation is not deleted; instead, it becomes an operation with
an Operation.error value with a google.rpc.Status.code of 1,
corresponding to Code.CANCELLED.
Deletes a long-running operation. This method indicates that the client is
no longer interested in the operation result. It does not cancel the
operation. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED.
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED.
Gets information about a location.
Lists information about the supported locations for this service.
Link to this section Functions
firestore_projects_databases_collection_groups_fields_get(connection, name, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_collection_groups_fields_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Field.t()} | {:error, Tesla.Env.t()}
Gets the metadata and configuration for a Field.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to servername(type:String.t) - A name of the formprojects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_id}optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Field{}}on success{:error, info}on failure
firestore_projects_databases_collection_groups_fields_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_collection_groups_fields_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1ListFieldsResponse.t()} | {:error, Tesla.Env.t()}
Lists the field configuration and metadata for this database.
Currently, FirestoreAdmin.ListFields only supports listing fields
that have been explicitly overridden. To issue this query, call
FirestoreAdmin.ListFields with the filter set to
indexConfig.usesAncestorConfig:false.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to serverparent(type:String.t) - A parent name of the formprojects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").:filter(type:String.t) - The filter to apply to list results. Currently, FirestoreAdmin.ListFields only supports listing fields that have been explicitly overridden. To issue this query, call FirestoreAdmin.ListFields with the filter set toindexConfig.usesAncestorConfig:false.:pageSize(type:integer()) - The number of results to return.:pageToken(type:String.t) - A page token, returned from a previous call to FirestoreAdmin.ListFields, that may be used to get the next page of results.
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1ListFieldsResponse{}}on success{:error, info}on failure
firestore_projects_databases_collection_groups_fields_patch(connection, name, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_collection_groups_fields_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.GoogleLongrunningOperation.t()} | {:error, Tesla.Env.t()}
Updates a field configuration. Currently, field updates apply only to
single field index configuration. However, calls to
FirestoreAdmin.UpdateField should provide a field mask to avoid
changing any configuration that the caller isn't aware of. The field mask
should be specified as: { paths: "index_config" }.
This call returns a google.longrunning.Operation which may be used to track the status of the field update. The metadata for the operation will be the type FieldOperationMetadata.
To configure the default field settings for the database, use
the special Field with resource name:
projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to servername(type:String.t) - A field name of the formprojects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/fields/{field_path}A field path may be a simple field name, e.g.
addressor a path to fields within map_value , e.g.address.city, or a special field path. The only valid special field is*, which represents any field.Field paths may be quoted using
(backtick). The only character that needs to be escaped within a quoted field path is the backtick character itself, escaped using a backslash. Special characters in field paths that must be quoted include:,., ``` (backtick),[,], as well as any ascii symbolic characters. Examples: (Note: Comments here are written in markdown syntax, so there is an additional layer of backticks to represent a code block)`address.city`represents a field namedaddress.city, not the map keycityin the fieldaddress.``represents a field named*`, not any field.A special
Fieldcontains the default indexing settings for all fields. This field's resource name is:projects/{project_id}/databases/{database_id}/collectionGroups/__default__/fields/*Indexes defined on thisFieldwill be applied to all fields which do not have their ownFieldindex configuration.optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").:updateMask(type:String.t) - A mask, relative to the field. If specified, only configuration specified by this field_mask will be updated in the field.:body(type:GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Field.t) -
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.GoogleLongrunningOperation{}}on success{:error, info}on failure
firestore_projects_databases_collection_groups_indexes_create(connection, parent, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_collection_groups_indexes_create( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.GoogleLongrunningOperation.t()} | {:error, Tesla.Env.t()}
Creates a composite index. This returns a google.longrunning.Operation which may be used to track the status of the creation. The metadata for the operation will be the type IndexOperationMetadata.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to serverparent(type:String.t) - A parent name of the formprojects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").:body(type:GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Index.t) -
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.GoogleLongrunningOperation{}}on success{:error, info}on failure
firestore_projects_databases_collection_groups_indexes_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_collection_groups_indexes_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}
Deletes a composite index.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to servername(type:String.t) - A name of the formprojects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.Empty{}}on success{:error, info}on failure
firestore_projects_databases_collection_groups_indexes_get(connection, name, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_collection_groups_indexes_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Index.t()} | {:error, Tesla.Env.t()}
Gets a composite index.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to servername(type:String.t) - A name of the formprojects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}/indexes/{index_id}optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1Index{}}on success{:error, info}on failure
firestore_projects_databases_collection_groups_indexes_list(connection, parent, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_collection_groups_indexes_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1ListIndexesResponse.t()} | {:error, Tesla.Env.t()}
Lists composite indexes.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to serverparent(type:String.t) - A parent name of the formprojects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").:filter(type:String.t) - The filter to apply to list results.:pageSize(type:integer()) - The number of results to return.:pageToken(type:String.t) - A page token, returned from a previous call to FirestoreAdmin.ListIndexes, that may be used to get the next page of results.
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1ListIndexesResponse{}}on success{:error, info}on failure
firestore_projects_databases_documents_batch_get(connection, database, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_documents_batch_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.BatchGetDocumentsResponse.t()} | {:error, Tesla.Env.t()}
Gets multiple documents.
Documents returned by this method are not guaranteed to be returned in the same order that they were requested.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to serverdatabase(type:String.t) - The database name. In the format:projects/{project_id}/databases/{database_id}.optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").:body(type:GoogleApi.Firestore.V1.Model.BatchGetDocumentsRequest.t) -
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.BatchGetDocumentsResponse{}}on success{:error, info}on failure
firestore_projects_databases_documents_begin_transaction(connection, database, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_documents_begin_transaction( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.BeginTransactionResponse.t()} | {:error, Tesla.Env.t()}
Starts a new transaction.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to serverdatabase(type:String.t) - The database name. In the format:projects/{project_id}/databases/{database_id}.optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").:body(type:GoogleApi.Firestore.V1.Model.BeginTransactionRequest.t) -
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.BeginTransactionResponse{}}on success{:error, info}on failure
firestore_projects_databases_documents_commit(connection, database, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_documents_commit( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.CommitResponse.t()} | {:error, Tesla.Env.t()}
Commits a transaction, while optionally updating documents.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to serverdatabase(type:String.t) - The database name. In the format:projects/{project_id}/databases/{database_id}.optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").:body(type:GoogleApi.Firestore.V1.Model.CommitRequest.t) -
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.CommitResponse{}}on success{:error, info}on failure
firestore_projects_databases_documents_create_document(connection, parent, collection_id, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_documents_create_document( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.Document.t()} | {:error, Tesla.Env.t()}
Creates a new document.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to serverparent(type:String.t) - The parent resource. For example:projects/{project_id}/databases/{database_id}/documentsorprojects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}collection_id(type:String.t) - The collection ID, relative toparent, to list. For example:chatrooms.optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").:documentId(type:String.t) - The client-assigned document ID to use for this document.Optional. If not specified, an ID will be assigned by the service.
:"mask.fieldPaths"(type:list(String.t)) - The list of field paths in the mask. See Document.fields for a field path syntax reference.:body(type:GoogleApi.Firestore.V1.Model.Document.t) -
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.Document{}}on success{:error, info}on failure
firestore_projects_databases_documents_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_documents_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}
Deletes a document.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to servername(type:String.t) - The resource name of the Document to delete. In the format:projects/{project_id}/databases/{database_id}/documents/{document_path}.optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").:"currentDocument.exists"(type:boolean()) - When set totrue, the target document must exist. When set tofalse, the target document must not exist.:"currentDocument.updateTime"(type:DateTime.t) - When set, the target document must exist and have been last updated at that time.
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.Empty{}}on success{:error, info}on failure
firestore_projects_databases_documents_get(connection, name, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_documents_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.Document.t()} | {:error, Tesla.Env.t()}
Gets a single document.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to servername(type:String.t) - The resource name of the Document to get. In the format:projects/{project_id}/databases/{database_id}/documents/{document_path}.optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").:"mask.fieldPaths"(type:list(String.t)) - The list of field paths in the mask. See Document.fields for a field path syntax reference.:readTime(type:DateTime.t) - Reads the version of the document at the given time. This may not be older than 60 seconds.:transaction(type:String.t) - Reads the document in a transaction.
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.Document{}}on success{:error, info}on failure
firestore_projects_databases_documents_list(connection, parent, collection_id, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_documents_list( Tesla.Env.client(), String.t(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.ListDocumentsResponse.t()} | {:error, Tesla.Env.t()}
Lists documents.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to serverparent(type:String.t) - The parent resource name. In the format:projects/{project_id}/databases/{database_id}/documentsorprojects/{project_id}/databases/{database_id}/documents/{document_path}. For example:projects/my-project/databases/my-database/documentsorprojects/my-project/databases/my-database/documents/chatrooms/my-chatroomcollection_id(type:String.t) - The collection ID, relative toparent, to list. For example:chatroomsormessages.optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").:"mask.fieldPaths"(type:list(String.t)) - The list of field paths in the mask. See Document.fields for a field path syntax reference.:orderBy(type:String.t) - The order to sort results by. For example:priority desc, name.:pageSize(type:integer()) - The maximum number of documents to return.:pageToken(type:String.t) - Thenext_page_tokenvalue returned from a previous List request, if any.:readTime(type:DateTime.t) - Reads documents as they were at the given time. This may not be older than 60 seconds.:showMissing(type:boolean()) - If the list should show missing documents. A missing document is a document that does not exist but has sub-documents. These documents will be returned with a key but will not have fields, Document.create_time, or Document.update_time set.Requests with
show_missingmay not specifywhereororder_by.:transaction(type:String.t) - Reads documents in a transaction.
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.ListDocumentsResponse{}}on success{:error, info}on failure
firestore_projects_databases_documents_list_collection_ids(connection, parent, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_documents_list_collection_ids( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.ListCollectionIdsResponse.t()} | {:error, Tesla.Env.t()}
Lists all the collection IDs underneath a document.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to serverparent(type:String.t) - The parent document. In the format:projects/{project_id}/databases/{database_id}/documents/{document_path}. For example:projects/my-project/databases/my-database/documents/chatrooms/my-chatroomoptional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").:body(type:GoogleApi.Firestore.V1.Model.ListCollectionIdsRequest.t) -
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.ListCollectionIdsResponse{}}on success{:error, info}on failure
firestore_projects_databases_documents_listen(connection, database, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_documents_listen( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.ListenResponse.t()} | {:error, Tesla.Env.t()}
Listens to changes.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to serverdatabase(type:String.t) - The database name. In the format:projects/{project_id}/databases/{database_id}.optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").:body(type:GoogleApi.Firestore.V1.Model.ListenRequest.t) -
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.ListenResponse{}}on success{:error, info}on failure
firestore_projects_databases_documents_patch(connection, name, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_documents_patch( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.Document.t()} | {:error, Tesla.Env.t()}
Updates or inserts a document.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to servername(type:String.t) - The resource name of the document, for exampleprojects/{project_id}/databases/{database_id}/documents/{document_path}.optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").:"currentDocument.exists"(type:boolean()) - When set totrue, the target document must exist. When set tofalse, the target document must not exist.:"currentDocument.updateTime"(type:DateTime.t) - When set, the target document must exist and have been last updated at that time.:"mask.fieldPaths"(type:list(String.t)) - The list of field paths in the mask. See Document.fields for a field path syntax reference.:"updateMask.fieldPaths"(type:list(String.t)) - The list of field paths in the mask. See Document.fields for a field path syntax reference.:body(type:GoogleApi.Firestore.V1.Model.Document.t) -
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.Document{}}on success{:error, info}on failure
firestore_projects_databases_documents_rollback(connection, database, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_documents_rollback( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}
Rolls back a transaction.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to serverdatabase(type:String.t) - The database name. In the format:projects/{project_id}/databases/{database_id}.optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").:body(type:GoogleApi.Firestore.V1.Model.RollbackRequest.t) -
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.Empty{}}on success{:error, info}on failure
firestore_projects_databases_documents_run_query(connection, parent, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_documents_run_query( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.RunQueryResponse.t()} | {:error, Tesla.Env.t()}
Runs a query.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to serverparent(type:String.t) - The parent resource name. In the format:projects/{project_id}/databases/{database_id}/documentsorprojects/{project_id}/databases/{database_id}/documents/{document_path}. For example:projects/my-project/databases/my-database/documentsorprojects/my-project/databases/my-database/documents/chatrooms/my-chatroomoptional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").:body(type:GoogleApi.Firestore.V1.Model.RunQueryRequest.t) -
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.RunQueryResponse{}}on success{:error, info}on failure
firestore_projects_databases_documents_write(connection, database, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_documents_write( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.WriteResponse.t()} | {:error, Tesla.Env.t()}
Streams batches of document updates and deletes, in order.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to serverdatabase(type:String.t) - The database name. In the format:projects/{project_id}/databases/{database_id}. This is only required in the first message.optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").:body(type:GoogleApi.Firestore.V1.Model.WriteRequest.t) -
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.WriteResponse{}}on success{:error, info}on failure
firestore_projects_databases_export_documents(connection, name, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_export_documents( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.GoogleLongrunningOperation.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to servername(type:String.t) - Database to export. Should be of the form:projects/{project_id}/databases/{database_id}.optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").:body(type:GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1ExportDocumentsRequest.t) -
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.GoogleLongrunningOperation{}}on success{:error, info}on failure
firestore_projects_databases_import_documents(connection, name, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_import_documents( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.GoogleLongrunningOperation.t()} | {:error, Tesla.Env.t()}
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.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to servername(type:String.t) - Database to import into. Should be of the form:projects/{project_id}/databases/{database_id}.optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").:body(type:GoogleApi.Firestore.V1.Model.GoogleFirestoreAdminV1ImportDocumentsRequest.t) -
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.GoogleLongrunningOperation{}}on success{:error, info}on failure
firestore_projects_databases_operations_cancel(connection, name, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_operations_cancel( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}
Starts asynchronous cancellation on a long-running operation. The server
makes a best effort to cancel the operation, but success is not
guaranteed. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED. Clients can use
Operations.GetOperation or
other methods to check whether the cancellation succeeded or whether the
operation completed despite cancellation. On successful cancellation,
the operation is not deleted; instead, it becomes an operation with
an Operation.error value with a google.rpc.Status.code of 1,
corresponding to Code.CANCELLED.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to servername(type:String.t) - The name of the operation resource to be cancelled.optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").:body(type:GoogleApi.Firestore.V1.Model.GoogleLongrunningCancelOperationRequest.t) -
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.Empty{}}on success{:error, info}on failure
firestore_projects_databases_operations_delete(connection, name, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_operations_delete( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.Empty.t()} | {:error, Tesla.Env.t()}
Deletes a long-running operation. This method indicates that the client is
no longer interested in the operation result. It does not cancel the
operation. If the server doesn't support this method, it returns
google.rpc.Code.UNIMPLEMENTED.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to servername(type:String.t) - The name of the operation resource to be deleted.optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.Empty{}}on success{:error, info}on failure
firestore_projects_databases_operations_get(connection, name, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_operations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.GoogleLongrunningOperation.t()} | {:error, Tesla.Env.t()}
Gets the latest state of a long-running operation. Clients can use this method to poll the operation result at intervals as recommended by the API service.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to servername(type:String.t) - The name of the operation resource.optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.GoogleLongrunningOperation{}}on success{:error, info}on failure
firestore_projects_databases_operations_list(connection, name, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_databases_operations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.GoogleLongrunningListOperationsResponse.t()} | {:error, Tesla.Env.t()}
Lists operations that match the specified filter in the request. If the
server doesn't support this method, it returns UNIMPLEMENTED.
NOTE: the name binding allows API services to override the binding
to use different resource name schemes, such as users/*/operations. To
override the binding, API services can add a binding such as
"/v1/{name=users/*}/operations" to their service configuration.
For backwards compatibility, the default name includes the operations
collection id, however overriding users must ensure the name binding
is the parent resource, without the operations collection id.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to servername(type:String.t) - The name of the operation's parent resource.optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").:filter(type:String.t) - The standard list filter.:pageSize(type:integer()) - The standard list page size.:pageToken(type:String.t) - The standard list page token.
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.GoogleLongrunningListOperationsResponse{}}on success{:error, info}on failure
firestore_projects_locations_get(connection, name, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_locations_get( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.Location.t()} | {:error, Tesla.Env.t()}
Gets information about a location.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to servername(type:String.t) - Resource name for the location.optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.Location{}}on success{:error, info}on failure
firestore_projects_locations_list(connection, name, optional_params \\ [], opts \\ [])
View Sourcefirestore_projects_locations_list( Tesla.Env.client(), String.t(), keyword(), keyword() ) :: {:ok, GoogleApi.Firestore.V1.Model.ListLocationsResponse.t()} | {:error, Tesla.Env.t()}
Lists information about the supported locations for this service.
Parameters
connection(type:GoogleApi.Firestore.V1.Connection.t) - Connection to servername(type:String.t) - The resource that owns the locations collection, if applicable.optional_params(type:keyword()) - Optional parameters:"$.xgafv"(type:String.t) - V1 error format.:access_token(type:String.t) - OAuth access token.:alt(type:String.t) - Data format for response.:callback(type:String.t) - JSONP:fields(type:String.t) - Selector specifying which fields to include in a partial response.:key(type:String.t) - 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.:oauth_token(type:String.t) - OAuth 2.0 token for the current user.:prettyPrint(type:boolean()) - Returns response with indentations and line breaks.:quotaUser(type:String.t) - 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.:uploadType(type:String.t) - Legacy upload protocol for media (e.g. "media", "multipart").:upload_protocol(type:String.t) - Upload protocol for media (e.g. "raw", "multipart").:filter(type:String.t) - The standard list filter.:pageSize(type:integer()) - The standard list page size.:pageToken(type:String.t) - The standard list page token.
opts(type:keyword()) - Call options
Returns
{:ok, %GoogleApi.Firestore.V1.Model.ListLocationsResponse{}}on success{:error, info}on failure