google_api_firestore

v0.0.1

google_api_firestore v0.0.1 GoogleApi.Firestore.V1beta1.Api.Projects View Source

API calls for all endpoints tagged Projects.

Link to this section Summary

Functions

firestore_projects_databases_documents_batch_get(connection, database, opts \\ [])

Gets multiple documents. Documents returned by this method are not guaranteed to be returned in the same order that they were requested

firestore_projects_databases_documents_begin_transaction(connection, database, opts \\ [])

Starts a new transaction

firestore_projects_databases_documents_commit(connection, database, opts \\ [])

Commits a transaction, while optionally updating documents

firestore_projects_databases_documents_create_document(connection, parent, collection_id, opts \\ [])

Creates a new document

firestore_projects_databases_documents_delete(connection, name, opts \\ [])

Deletes a document

firestore_projects_databases_documents_get(connection, name, opts \\ [])

Gets a single document

firestore_projects_databases_documents_list(connection, parent, collection_id, opts \\ [])

Lists documents

firestore_projects_databases_documents_list_collection_ids(connection, parent, opts \\ [])

Lists all the collection IDs underneath a document

firestore_projects_databases_documents_listen(connection, database, opts \\ [])

Listens to changes

firestore_projects_databases_documents_patch(connection, name, opts \\ [])

Updates or inserts a document

firestore_projects_databases_documents_rollback(connection, database, opts \\ [])

Rolls back a transaction

firestore_projects_databases_documents_run_query(connection, parent, opts \\ [])

Runs a query

firestore_projects_databases_documents_write(connection, database, opts \\ [])

Streams batches of document updates and deletes, in order

firestore_projects_databases_indexes_create(connection, parent, opts \\ [])

Creates the specified index. A newly created index's initial state is `CREATING`. On completion of the returned google.longrunning.Operation, the state will be `READY`. If the index already exists, the call will return an `ALREADY_EXISTS` status. During creation, the process could result in an error, in which case the index will move to the `ERROR` 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

firestore_projects_databases_indexes_list(connection, parent, opts \\ [])

Lists the indexes that match the specified filters

Link to this section Functions

Link to this function firestore_projects_databases_documents_batch_get(connection, database, opts \\ []) View Source 
firestore_projects_databases_documents_batch_get(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.Firestore.V1beta1.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 (GoogleApi.Firestore.V1beta1.Connection): Connection to server
  • database (String.t): The database name. In the format: `projects/{project_id}/databases/{database_id}`.

  • opts (KeywordList): [optional] Optional parameters

    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :$.xgafv (String.t): V1 error format.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (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.
    • :quotaUser (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.
    • :pp (boolean()): Pretty-print response.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :bearer_token (String.t): OAuth bearer token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :body (BatchGetDocumentsRequest):

Returns

{:ok, %GoogleApi.Firestore.V1beta1.Model.BatchGetDocumentsResponse{}} on success {:error, info} on failure

Link to this function firestore_projects_databases_documents_begin_transaction(connection, database, opts \\ []) View Source 
firestore_projects_databases_documents_begin_transaction(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.Firestore.V1beta1.Model.BeginTransactionResponse.t()}
  | {:error, Tesla.Env.t()}

Starts a new transaction.

Parameters

  • connection (GoogleApi.Firestore.V1beta1.Connection): Connection to server
  • database (String.t): The database name. In the format: `projects/{project_id}/databases/{database_id}`.

  • opts (KeywordList): [optional] Optional parameters

    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :$.xgafv (String.t): V1 error format.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (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.
    • :quotaUser (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.
    • :pp (boolean()): Pretty-print response.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :bearer_token (String.t): OAuth bearer token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :body (BeginTransactionRequest):

Returns

{:ok, %GoogleApi.Firestore.V1beta1.Model.BeginTransactionResponse{}} on success {:error, info} on failure

Link to this function firestore_projects_databases_documents_commit(connection, database, opts \\ []) View Source 
firestore_projects_databases_documents_commit(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.Firestore.V1beta1.Model.CommitResponse.t()}
  | {:error, Tesla.Env.t()}

Commits a transaction, while optionally updating documents.

Parameters

  • connection (GoogleApi.Firestore.V1beta1.Connection): Connection to server
  • database (String.t): The database name. In the format: `projects/{project_id}/databases/{database_id}`.

  • opts (KeywordList): [optional] Optional parameters

    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :$.xgafv (String.t): V1 error format.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (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.
    • :quotaUser (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.
    • :pp (boolean()): Pretty-print response.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :bearer_token (String.t): OAuth bearer token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :body (CommitRequest):

Returns

{:ok, %GoogleApi.Firestore.V1beta1.Model.CommitResponse{}} on success {:error, info} on failure

Link to this function firestore_projects_databases_documents_create_document(connection, parent, collection_id, opts \\ []) View Source 
firestore_projects_databases_documents_create_document(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.Firestore.V1beta1.Model.Document.t()}
  | {:error, Tesla.Env.t()}

Creates a new document.

Parameters

  • connection (GoogleApi.Firestore.V1beta1.Connection): Connection to server
  • parent (String.t): The parent resource. For example: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/chatrooms/{chatroom_id}`
  • collection_id (String.t): The collection ID, relative to `parent`, to list. For example: `chatrooms`.

  • opts (KeywordList): [optional] Optional parameters

    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :$.xgafv (String.t): V1 error format.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (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.
    • :quotaUser (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.
    • :pp (boolean()): Pretty-print response.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :bearer_token (String.t): OAuth bearer token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :mask.fieldPaths ([String.t]): The list of field paths in the mask. See Document.fields for a field path syntax reference.
    • :documentId (String.t): The client-assigned document ID to use for this document. Optional. If not specified, an ID will be assigned by the service.
    • :body (Document):

Returns

{:ok, %GoogleApi.Firestore.V1beta1.Model.Document{}} on success {:error, info} on failure

Link to this function firestore_projects_databases_documents_delete(connection, name, opts \\ []) View Source 
firestore_projects_databases_documents_delete(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.Firestore.V1beta1.Model.Empty.t()} | {:error, Tesla.Env.t()}

Deletes a document.

Parameters

  • connection (GoogleApi.Firestore.V1beta1.Connection): Connection to server
  • name (String.t): The resource name of the Document to delete. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.

  • opts (KeywordList): [optional] Optional parameters

    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :$.xgafv (String.t): V1 error format.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (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.
    • :quotaUser (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.
    • :pp (boolean()): Pretty-print response.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :bearer_token (String.t): OAuth bearer token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :currentDocument.updateTime (String.t): When set, the target document must exist and have been last updated at that time.
    • :currentDocument.exists (boolean()): When set to `true`, the target document must exist. When set to `false`, the target document must not exist.

Returns

{:ok, %GoogleApi.Firestore.V1beta1.Model.Empty{}} on success {:error, info} on failure

Link to this function firestore_projects_databases_documents_get(connection, name, opts \\ []) View Source 
firestore_projects_databases_documents_get(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.Firestore.V1beta1.Model.Document.t()}
  | {:error, Tesla.Env.t()}

Gets a single document.

Parameters

  • connection (GoogleApi.Firestore.V1beta1.Connection): Connection to server
  • name (String.t): The resource name of the Document to get. In the format: `projects/{project_id}/databases/{database_id}/documents/{document_path}`.

  • opts (KeywordList): [optional] Optional parameters

    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :$.xgafv (String.t): V1 error format.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (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.
    • :quotaUser (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.
    • :pp (boolean()): Pretty-print response.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :bearer_token (String.t): OAuth bearer token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :mask.fieldPaths ([String.t]): The list of field paths in the mask. See Document.fields for a field path syntax reference.
    • :readTime (String.t): Reads the version of the document at the given time. This may not be older than 60 seconds.
    • :transaction (String.t): Reads the document in a transaction.

Returns

{:ok, %GoogleApi.Firestore.V1beta1.Model.Document{}} on success {:error, info} on failure

Link to this function firestore_projects_databases_documents_list(connection, parent, collection_id, opts \\ []) View Source 
firestore_projects_databases_documents_list(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.Firestore.V1beta1.Model.ListDocumentsResponse.t()}
  | {:error, Tesla.Env.t()}

Lists documents.

Parameters

  • connection (GoogleApi.Firestore.V1beta1.Connection): Connection to server
  • parent (String.t): The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`
  • collection_id (String.t): The collection ID, relative to `parent`, to list. For example: `chatrooms` or `messages`.

  • opts (KeywordList): [optional] Optional parameters

    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :$.xgafv (String.t): V1 error format.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (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.
    • :quotaUser (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.
    • :pp (boolean()): Pretty-print response.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :bearer_token (String.t): OAuth bearer token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :mask.fieldPaths ([String.t]): The list of field paths in the mask. See Document.fields for a field path syntax reference.
    • :pageToken (String.t): The `next_page_token` value returned from a previous List request, if any.
    • :pageSize (integer()): The maximum number of documents to return.
    • :transaction (String.t): Reads documents in a transaction.
    • :orderBy (String.t): The order to sort results by. For example: `priority desc, name`.
    • :readTime (String.t): Reads documents as they were at the given time. This may not be older than 60 seconds.
    • :showMissing (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_missing` may not specify `where` or `order_by`.

Returns

{:ok, %GoogleApi.Firestore.V1beta1.Model.ListDocumentsResponse{}} on success {:error, info} on failure

Link to this function firestore_projects_databases_documents_list_collection_ids(connection, parent, opts \\ []) View Source 
firestore_projects_databases_documents_list_collection_ids(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.Firestore.V1beta1.Model.ListCollectionIdsResponse.t()}
  | {:error, Tesla.Env.t()}

Lists all the collection IDs underneath a document.

Parameters

  • connection (GoogleApi.Firestore.V1beta1.Connection): Connection to server
  • parent (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-chatroom`

  • opts (KeywordList): [optional] Optional parameters

    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :$.xgafv (String.t): V1 error format.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (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.
    • :quotaUser (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.
    • :pp (boolean()): Pretty-print response.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :bearer_token (String.t): OAuth bearer token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :body (ListCollectionIdsRequest):

Returns

{:ok, %GoogleApi.Firestore.V1beta1.Model.ListCollectionIdsResponse{}} on success {:error, info} on failure

Link to this function firestore_projects_databases_documents_listen(connection, database, opts \\ []) View Source 
firestore_projects_databases_documents_listen(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.Firestore.V1beta1.Model.ListenResponse.t()}
  | {:error, Tesla.Env.t()}

Listens to changes.

Parameters

  • connection (GoogleApi.Firestore.V1beta1.Connection): Connection to server
  • database (String.t): The database name. In the format: `projects/{project_id}/databases/{database_id}`.

  • opts (KeywordList): [optional] Optional parameters

    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :$.xgafv (String.t): V1 error format.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (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.
    • :quotaUser (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.
    • :pp (boolean()): Pretty-print response.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :bearer_token (String.t): OAuth bearer token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :body (ListenRequest):

Returns

{:ok, %GoogleApi.Firestore.V1beta1.Model.ListenResponse{}} on success {:error, info} on failure

Link to this function firestore_projects_databases_documents_patch(connection, name, opts \\ []) View Source 
firestore_projects_databases_documents_patch(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.Firestore.V1beta1.Model.Document.t()}
  | {:error, Tesla.Env.t()}

Updates or inserts a document.

Parameters

  • connection (GoogleApi.Firestore.V1beta1.Connection): Connection to server
  • name (String.t): The resource name of the document, for example `projects/{project_id}/databases/{database_id}/documents/{document_path}`.

  • opts (KeywordList): [optional] Optional parameters

    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :$.xgafv (String.t): V1 error format.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (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.
    • :quotaUser (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.
    • :pp (boolean()): Pretty-print response.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :bearer_token (String.t): OAuth bearer token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :updateMask.fieldPaths ([String.t]): The list of field paths in the mask. See Document.fields for a field path syntax reference.
    • :mask.fieldPaths ([String.t]): The list of field paths in the mask. See Document.fields for a field path syntax reference.
    • :currentDocument.updateTime (String.t): When set, the target document must exist and have been last updated at that time.
    • :currentDocument.exists (boolean()): When set to `true`, the target document must exist. When set to `false`, the target document must not exist.
    • :body (Document):

Returns

{:ok, %GoogleApi.Firestore.V1beta1.Model.Document{}} on success {:error, info} on failure

Link to this function firestore_projects_databases_documents_rollback(connection, database, opts \\ []) View Source 
firestore_projects_databases_documents_rollback(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.Firestore.V1beta1.Model.Empty.t()} | {:error, Tesla.Env.t()}

Rolls back a transaction.

Parameters

  • connection (GoogleApi.Firestore.V1beta1.Connection): Connection to server
  • database (String.t): The database name. In the format: `projects/{project_id}/databases/{database_id}`.

  • opts (KeywordList): [optional] Optional parameters

    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :$.xgafv (String.t): V1 error format.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (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.
    • :quotaUser (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.
    • :pp (boolean()): Pretty-print response.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :bearer_token (String.t): OAuth bearer token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :body (RollbackRequest):

Returns

{:ok, %GoogleApi.Firestore.V1beta1.Model.Empty{}} on success {:error, info} on failure

Link to this function firestore_projects_databases_documents_run_query(connection, parent, opts \\ []) View Source 
firestore_projects_databases_documents_run_query(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.Firestore.V1beta1.Model.RunQueryResponse.t()}
  | {:error, Tesla.Env.t()}

Runs a query.

Parameters

  • connection (GoogleApi.Firestore.V1beta1.Connection): Connection to server
  • parent (String.t): The parent resource name. In the format: `projects/{project_id}/databases/{database_id}/documents` or `projects/{project_id}/databases/{database_id}/documents/{document_path}`. For example: `projects/my-project/databases/my-database/documents` or `projects/my-project/databases/my-database/documents/chatrooms/my-chatroom`

  • opts (KeywordList): [optional] Optional parameters

    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :$.xgafv (String.t): V1 error format.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (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.
    • :quotaUser (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.
    • :pp (boolean()): Pretty-print response.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :bearer_token (String.t): OAuth bearer token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :body (RunQueryRequest):

Returns

{:ok, %GoogleApi.Firestore.V1beta1.Model.RunQueryResponse{}} on success {:error, info} on failure

Link to this function firestore_projects_databases_documents_write(connection, database, opts \\ []) View Source 
firestore_projects_databases_documents_write(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.Firestore.V1beta1.Model.WriteResponse.t()}
  | {:error, Tesla.Env.t()}

Streams batches of document updates and deletes, in order.

Parameters

  • connection (GoogleApi.Firestore.V1beta1.Connection): Connection to server
  • database (String.t): The database name. In the format: `projects/{project_id}/databases/{database_id}`. This is only required in the first message.

  • opts (KeywordList): [optional] Optional parameters

    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :$.xgafv (String.t): V1 error format.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (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.
    • :quotaUser (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.
    • :pp (boolean()): Pretty-print response.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :bearer_token (String.t): OAuth bearer token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :body (WriteRequest):

Returns

{:ok, %GoogleApi.Firestore.V1beta1.Model.WriteResponse{}} on success {:error, info} on failure

Link to this function firestore_projects_databases_indexes_create(connection, parent, opts \\ []) View Source 
firestore_projects_databases_indexes_create(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.Firestore.V1beta1.Model.Operation.t()}
  | {:error, Tesla.Env.t()}

Creates the specified index. A newly created index's initial state is `CREATING`. On completion of the returned google.longrunning.Operation, the state will be `READY`. If the index already exists, the call will return an `ALREADY_EXISTS` status. During creation, the process could result in an error, in which case the index will move to the `ERROR` 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.

Parameters

  • connection (GoogleApi.Firestore.V1beta1.Connection): Connection to server
  • parent (String.t): The name of the database this index will apply to. For example: `projects/{project_id}/databases/{database_id}`

  • opts (KeywordList): [optional] Optional parameters

    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :$.xgafv (String.t): V1 error format.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (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.
    • :quotaUser (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.
    • :pp (boolean()): Pretty-print response.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :bearer_token (String.t): OAuth bearer token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :body (Index):

Returns

{:ok, %GoogleApi.Firestore.V1beta1.Model.Operation{}} on success {:error, info} on failure

Link to this function firestore_projects_databases_indexes_list(connection, parent, opts \\ []) View Source 
firestore_projects_databases_indexes_list(
  Tesla.Env.client(),
  String.t(),
  keyword()
) ::
  {:ok, GoogleApi.Firestore.V1beta1.Model.ListIndexesResponse.t()}
  | {:error, Tesla.Env.t()}

Lists the indexes that match the specified filters.

Parameters

  • connection (GoogleApi.Firestore.V1beta1.Connection): Connection to server
  • parent (String.t): The database name. For example: `projects/{project_id}/databases/{database_id}`

  • opts (KeywordList): [optional] Optional parameters

    • :fields (String.t): Selector specifying which fields to include in a partial response.
    • :uploadType (String.t): Legacy upload protocol for media (e.g. "media", "multipart").
    • :$.xgafv (String.t): V1 error format.
    • :callback (String.t): JSONP
    • :alt (String.t): Data format for response.
    • :access_token (String.t): OAuth access token.
    • :key (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.
    • :quotaUser (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.
    • :pp (boolean()): Pretty-print response.
    • :oauth_token (String.t): OAuth 2.0 token for the current user.
    • :bearer_token (String.t): OAuth bearer token.
    • :upload_protocol (String.t): Upload protocol for media (e.g. "raw", "multipart").
    • :prettyPrint (boolean()): Returns response with indentations and line breaks.
    • :pageToken (String.t): The standard List page token.
    • :pageSize (integer()): The standard List page size.
    • :filter (String.t):

Returns

{:ok, %GoogleApi.Firestore.V1beta1.Model.ListIndexesResponse{}} on success {:error, info} on failure