docs/dyn/firestore_v1beta1.projects.databases.html - external/github.com/google/google-api-python-client - Git at Google

 <html><body>
 <style>

 body, h1, h2, h3, div, span, p, pre, a {
   margin: 0;
   padding: 0;
   border: 0;
   font-weight: inherit;
   font-style: inherit;
   font-size: 100%;
   font-family: inherit;
   vertical-align: baseline;
 }

 body {
   font-size: 13px;
   padding: 1em;
 }

 h1 {
   font-size: 26px;
   margin-bottom: 1em;
 }

 h2 {
   font-size: 24px;
   margin-bottom: 1em;
 }

 h3 {
   font-size: 20px;
   margin-bottom: 1em;
   margin-top: 1em;
 }

 pre, code {
   line-height: 1.5;
   font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
 }

 pre {
   margin-top: 0.5em;
 }

 h1, h2, h3, p {
   font-family: Arial, sans serif;
 }

 h1, h2, h3 {
   border-bottom: solid #CCC 1px;
 }

 .toc_element {
   margin-top: 0.5em;
 }

 .firstline {
   margin-left: 2 em;
 }

 .method  {
   margin-top: 1em;
   border: solid 1px #CCC;
   padding: 1em;
   background: #EEE;
 }

 .details {
   font-weight: bold;
   font-size: 14px;
 }

 </style>

 <h1><a href="firestore_v1beta1.html">Cloud Firestore API</a> . <a href="firestore_v1beta1.projects.html">projects</a> . <a href="firestore_v1beta1.projects.databases.html">databases</a></h1>
 <h2>Instance Methods</h2>
 <p class="toc_element">
   <code><a href="firestore_v1beta1.projects.databases.documents.html">documents()</a></code>
 </p>
 <p class="firstline">Returns the documents Resource.</p>

 <p class="toc_element">
   <code><a href="firestore_v1beta1.projects.databases.indexes.html">indexes()</a></code>
 </p>
 <p class="firstline">Returns the indexes Resource.</p>

 <p class="toc_element">
   <code><a href="#exportDocuments">exportDocuments(name, body=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Exports a copy of all or a subset of documents from Google Cloud Firestore</p>
 <p class="toc_element">
   <code><a href="#importDocuments">importDocuments(name, body=None, x__xgafv=None)</a></code></p>
 <p class="firstline">Imports documents into Google Cloud Firestore. Existing documents with the</p>
 <h3>Method Details</h3>
 <div class="method">
     <code class="details" id="exportDocuments">exportDocuments(name, body=None, x__xgafv=None)</code>
   <pre>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.

 Args:
   name: string, Database to export. Should be of the form:
 `projects/{project_id}/databases/{database_id}`. (required)
   body: object, The request body.
     The object takes the form of:

 { # The request for FirestoreAdmin.ExportDocuments.
     &quot;collectionIds&quot;: [ # Which collection ids to export. Unspecified means all collections.
       &quot;A String&quot;,
     ],
     &quot;outputUriPrefix&quot;: &quot;A String&quot;, # The output URI. Currently only supports Google Cloud Storage URIs of the
         # form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name
         # of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional
         # Google Cloud Storage namespace path. When
         # choosing a name, be sure to consider Google Cloud Storage naming
         # guidelines: https://cloud.google.com/storage/docs/naming.
         # If the URI is a bucket (without a namespace path), a prefix will be
         # generated based on the start time.
   }

   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # This resource represents a long-running operation that is the result of a
       # network API call.
     &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
         # If `true`, the operation is completed, and either `error` or `response` is
         # available.
     &quot;response&quot;: { # The normal response of the operation in case of success.  If the original
         # method returns no data on success, such as `Delete`, the response is
         # `google.protobuf.Empty`.  If the original method is standard
         # `Get`/`Create`/`Update`, the response should be the resource.  For other
         # methods, the response should have the type `XxxResponse`, where `Xxx`
         # is the original method name.  For example, if the original method name
         # is `TakeSnapshot()`, the inferred response type is
         # `TakeSnapshotResponse`.
       &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
     },
     &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
         # originally returns it. If you use the default HTTP mapping, the
         # `name` should be a resource name ending with `operations/{unique_id}`.
     &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
         # different programming environments, including REST APIs and RPC APIs. It is
         # used by [gRPC](https://github.com/grpc). Each `Status` message contains
         # three pieces of data: error code, error message, and error details.
         #
         # You can find out more about this error model and how to work with it in the
         # [API Design Guide](https://cloud.google.com/apis/design/errors).
       &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
       &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
           # user-facing error message should be localized and sent in the
           # google.rpc.Status.details field, or localized by the client.
       &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
           # message types for APIs to use.
         {
           &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
         },
       ],
     },
     &quot;metadata&quot;: { # Service-specific metadata associated with the operation.  It typically
         # contains progress information and common metadata such as create time.
         # Some services might not provide such metadata.  Any method that returns a
         # long-running operation should document the metadata type, if any.
       &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
     },
   }</pre>
 </div>

 <div class="method">
     <code class="details" id="importDocuments">importDocuments(name, body=None, x__xgafv=None)</code>
   <pre>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.

 Args:
   name: string, Database to import into. Should be of the form:
 `projects/{project_id}/databases/{database_id}`. (required)
   body: object, The request body.
     The object takes the form of:

 { # The request for FirestoreAdmin.ImportDocuments.
     &quot;collectionIds&quot;: [ # Which collection ids to import. Unspecified means all collections included
         # in the import.
       &quot;A String&quot;,
     ],
     &quot;inputUriPrefix&quot;: &quot;A String&quot;, # Location of the exported files.
         # This must match the output_uri_prefix of an ExportDocumentsResponse from
         # an export that has completed successfully.
         # See:
         # google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix.
   }

   x__xgafv: string, V1 error format.
     Allowed values
       1 - v1 error format
       2 - v2 error format

 Returns:
   An object of the form:

     { # This resource represents a long-running operation that is the result of a
       # network API call.
     &quot;done&quot;: True or False, # If the value is `false`, it means the operation is still in progress.
         # If `true`, the operation is completed, and either `error` or `response` is
         # available.
     &quot;response&quot;: { # The normal response of the operation in case of success.  If the original
         # method returns no data on success, such as `Delete`, the response is
         # `google.protobuf.Empty`.  If the original method is standard
         # `Get`/`Create`/`Update`, the response should be the resource.  For other
         # methods, the response should have the type `XxxResponse`, where `Xxx`
         # is the original method name.  For example, if the original method name
         # is `TakeSnapshot()`, the inferred response type is
         # `TakeSnapshotResponse`.
       &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
     },
     &quot;name&quot;: &quot;A String&quot;, # The server-assigned name, which is only unique within the same service that
         # originally returns it. If you use the default HTTP mapping, the
         # `name` should be a resource name ending with `operations/{unique_id}`.
     &quot;error&quot;: { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
         # different programming environments, including REST APIs and RPC APIs. It is
         # used by [gRPC](https://github.com/grpc). Each `Status` message contains
         # three pieces of data: error code, error message, and error details.
         #
         # You can find out more about this error model and how to work with it in the
         # [API Design Guide](https://cloud.google.com/apis/design/errors).
       &quot;code&quot;: 42, # The status code, which should be an enum value of google.rpc.Code.
       &quot;message&quot;: &quot;A String&quot;, # A developer-facing error message, which should be in English. Any
           # user-facing error message should be localized and sent in the
           # google.rpc.Status.details field, or localized by the client.
       &quot;details&quot;: [ # A list of messages that carry the error details.  There is a common set of
           # message types for APIs to use.
         {
           &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
         },
       ],
     },
     &quot;metadata&quot;: { # Service-specific metadata associated with the operation.  It typically
         # contains progress information and common metadata such as create time.
         # Some services might not provide such metadata.  Any method that returns a
         # long-running operation should document the metadata type, if any.
       &quot;a_key&quot;: &quot;&quot;, # Properties of the object. Contains field @type with type URL.
     },
   }</pre>
 </div>

 </body></html>
	<html><body>
	<style>

	body, h1, h2, h3, div, span, p, pre, a {
	margin: 0;
	padding: 0;
	border: 0;
	font-weight: inherit;
	font-style: inherit;
	font-size: 100%;
	font-family: inherit;
	vertical-align: baseline;
	}

	body {
	font-size: 13px;
	padding: 1em;
	}

	h1 {
	font-size: 26px;
	margin-bottom: 1em;
	}

	h2 {
	font-size: 24px;
	margin-bottom: 1em;
	}

	h3 {
	font-size: 20px;
	margin-bottom: 1em;
	margin-top: 1em;
	}

	pre, code {
	line-height: 1.5;
	font-family: Monaco, 'DejaVu Sans Mono', 'Bitstream Vera Sans Mono', 'Lucida Console', monospace;
	}

	pre {
	margin-top: 0.5em;
	}

	h1, h2, h3, p {
	font-family: Arial, sans serif;
	}

	h1, h2, h3 {
	border-bottom: solid #CCC 1px;
	}

	.toc_element {
	margin-top: 0.5em;
	}

	.firstline {
	margin-left: 2 em;
	}

	.method {
	margin-top: 1em;
	border: solid 1px #CCC;
	padding: 1em;
	background: #EEE;
	}

	.details {
	font-weight: bold;
	font-size: 14px;
	}

	</style>

	<h1><a href="firestore_v1beta1.html">Cloud Firestore API</a> . <a href="firestore_v1beta1.projects.html">projects</a> . <a href="firestore_v1beta1.projects.databases.html">databases</a></h1>
	<h2>Instance Methods</h2>
	<p class="toc_element">
	<code><a href="firestore_v1beta1.projects.databases.documents.html">documents()</a></code>
	</p>
	<p class="firstline">Returns the documents Resource.</p>

	<p class="toc_element">
	<code><a href="firestore_v1beta1.projects.databases.indexes.html">indexes()</a></code>
	</p>
	<p class="firstline">Returns the indexes Resource.</p>

	<p class="toc_element">
	<code><a href="#exportDocuments">exportDocuments(name, body=None, x__xgafv=None)</a></code></p>
	<p class="firstline">Exports a copy of all or a subset of documents from Google Cloud Firestore</p>
	<p class="toc_element">
	<code><a href="#importDocuments">importDocuments(name, body=None, x__xgafv=None)</a></code></p>
	<p class="firstline">Imports documents into Google Cloud Firestore. Existing documents with the</p>
	<h3>Method Details</h3>
	<div class="method">
	<code class="details" id="exportDocuments">exportDocuments(name, body=None, x__xgafv=None)</code>
	<pre>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.

	Args:
	name: string, Database to export. Should be of the form:
	`projects/{project_id}/databases/{database_id}`. (required)
	body: object, The request body.
	The object takes the form of:

	{ # The request for FirestoreAdmin.ExportDocuments.
	"collectionIds": [ # Which collection ids to export. Unspecified means all collections.
	"A String",
	],
	"outputUriPrefix": "A String", # The output URI. Currently only supports Google Cloud Storage URIs of the
	# form: `gs://BUCKET_NAME[/NAMESPACE_PATH]`, where `BUCKET_NAME` is the name
	# of the Google Cloud Storage bucket and `NAMESPACE_PATH` is an optional
	# Google Cloud Storage namespace path. When
	# choosing a name, be sure to consider Google Cloud Storage naming
	# guidelines: https://cloud.google.com/storage/docs/naming.
	# If the URI is a bucket (without a namespace path), a prefix will be
	# generated based on the start time.
	}

	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # This resource represents a long-running operation that is the result of a
	# network API call.
	"done": True or False, # If the value is `false`, it means the operation is still in progress.
	# If `true`, the operation is completed, and either `error` or `response` is
	# available.
	"response": { # The normal response of the operation in case of success. If the original
	# method returns no data on success, such as `Delete`, the response is
	# `google.protobuf.Empty`. If the original method is standard
	# `Get`/`Create`/`Update`, the response should be the resource. For other
	# methods, the response should have the type `XxxResponse`, where `Xxx`
	# is the original method name. For example, if the original method name
	# is `TakeSnapshot()`, the inferred response type is
	# `TakeSnapshotResponse`.
	"a_key": "", # Properties of the object. Contains field @type with type URL.
	},
	"name": "A String", # The server-assigned name, which is only unique within the same service that
	# originally returns it. If you use the default HTTP mapping, the
	# `name` should be a resource name ending with `operations/{unique_id}`.
	"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
	# different programming environments, including REST APIs and RPC APIs. It is
	# used by [gRPC](https://github.com/grpc). Each `Status` message contains
	# three pieces of data: error code, error message, and error details.
	#
	# You can find out more about this error model and how to work with it in the
	# [API Design Guide](https://cloud.google.com/apis/design/errors).
	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
	"message": "A String", # A developer-facing error message, which should be in English. Any
	# user-facing error message should be localized and sent in the
	# google.rpc.Status.details field, or localized by the client.
	"details": [ # A list of messages that carry the error details. There is a common set of
	# message types for APIs to use.
	{
	"a_key": "", # Properties of the object. Contains field @type with type URL.
	},
	],
	},
	"metadata": { # Service-specific metadata associated with the operation. It typically
	# contains progress information and common metadata such as create time.
	# Some services might not provide such metadata. Any method that returns a
	# long-running operation should document the metadata type, if any.
	"a_key": "", # Properties of the object. Contains field @type with type URL.
	},
	}</pre>
	</div>

	<div class="method">
	<code class="details" id="importDocuments">importDocuments(name, body=None, x__xgafv=None)</code>
	<pre>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.

	Args:
	name: string, Database to import into. Should be of the form:
	`projects/{project_id}/databases/{database_id}`. (required)
	body: object, The request body.
	The object takes the form of:

	{ # The request for FirestoreAdmin.ImportDocuments.
	"collectionIds": [ # Which collection ids to import. Unspecified means all collections included
	# in the import.
	"A String",
	],
	"inputUriPrefix": "A String", # Location of the exported files.
	# This must match the output_uri_prefix of an ExportDocumentsResponse from
	# an export that has completed successfully.
	# See:
	# google.firestore.admin.v1beta1.ExportDocumentsResponse.output_uri_prefix.
	}

	x__xgafv: string, V1 error format.
	Allowed values
	1 - v1 error format
	2 - v2 error format

	Returns:
	An object of the form:

	{ # This resource represents a long-running operation that is the result of a
	# network API call.
	"done": True or False, # If the value is `false`, it means the operation is still in progress.
	# If `true`, the operation is completed, and either `error` or `response` is
	# available.
	"response": { # The normal response of the operation in case of success. If the original
	# method returns no data on success, such as `Delete`, the response is
	# `google.protobuf.Empty`. If the original method is standard
	# `Get`/`Create`/`Update`, the response should be the resource. For other
	# methods, the response should have the type `XxxResponse`, where `Xxx`
	# is the original method name. For example, if the original method name
	# is `TakeSnapshot()`, the inferred response type is
	# `TakeSnapshotResponse`.
	"a_key": "", # Properties of the object. Contains field @type with type URL.
	},
	"name": "A String", # The server-assigned name, which is only unique within the same service that
	# originally returns it. If you use the default HTTP mapping, the
	# `name` should be a resource name ending with `operations/{unique_id}`.
	"error": { # The `Status` type defines a logical error model that is suitable for # The error result of the operation in case of failure or cancellation.
	# different programming environments, including REST APIs and RPC APIs. It is
	# used by [gRPC](https://github.com/grpc). Each `Status` message contains
	# three pieces of data: error code, error message, and error details.
	#
	# You can find out more about this error model and how to work with it in the
	# [API Design Guide](https://cloud.google.com/apis/design/errors).
	"code": 42, # The status code, which should be an enum value of google.rpc.Code.
	"message": "A String", # A developer-facing error message, which should be in English. Any
	# user-facing error message should be localized and sent in the
	# google.rpc.Status.details field, or localized by the client.
	"details": [ # A list of messages that carry the error details. There is a common set of
	# message types for APIs to use.
	{
	"a_key": "", # Properties of the object. Contains field @type with type URL.
	},
	],
	},
	"metadata": { # Service-specific metadata associated with the operation. It typically
	# contains progress information and common metadata such as create time.
	# Some services might not provide such metadata. Any method that returns a
	# long-running operation should document the metadata type, if any.
	"a_key": "", # Properties of the object. Contains field @type with type URL.
	},
	}</pre>
	</div>

	</body></html>