Skip to content

Commit

Permalink
feat(firestore): update the api
Browse files Browse the repository at this point in the history
#### firestore:v1

The following keys were added:
- schemas.GoogleFirestoreAdminV1RestoreDatabaseMetadata (Total Keys: 9)

#### firestore:v1beta1

The following keys were added:
- schemas.GoogleFirestoreAdminV1RestoreDatabaseMetadata (Total Keys: 9)

#### firestore:v1beta2

The following keys were added:
- schemas.GoogleFirestoreAdminV1RestoreDatabaseMetadata (Total Keys: 9)
  • Loading branch information
yoshi-automation committed Jul 5, 2023
1 parent e6c55df commit 9999852
Show file tree
Hide file tree
Showing 7 changed files with 453 additions and 270 deletions.
Expand Up @@ -82,7 +82,7 @@ <h2>Instance Methods</h2>
<p class="firstline">Gets the metadata and configuration for a Field.</p>
<p class="toc_element">
<code><a href="#list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</a></code></p>
<p class="firstline">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` .</p>
<p class="firstline">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 or `ttlConfig:*`.</p>
<p class="toc_element">
<code><a href="#list_next">list_next()</a></code></p>
<p class="firstline">Retrieves the next page of results.</p>
Expand Down Expand Up @@ -139,7 +139,7 @@ <h3>Method Details</h3>

<div class="method">
<code class="details" id="list">list(parent, filter=None, pageSize=None, pageToken=None, x__xgafv=None)</code>
<pre>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` .
<pre>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 or `ttlConfig:*`.

Args:
parent: string, Required. A parent name of the form `projects/{project_id}/databases/{database_id}/collectionGroups/{collection_id}` (required)
Expand Down
8 changes: 4 additions & 4 deletions docs/dyn/firestore_v1.projects.databases.documents.html
Expand Up @@ -163,7 +163,7 @@ <h3>Method Details</h3>
&quot;readOnly&quot;: { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents at the given time. This may not be older than 60 seconds.
},
&quot;readWrite&quot;: { # Options for a transaction that can be used to read and write documents. # The transaction can be used for both read and write operations.
&quot;readWrite&quot;: { # Options for a transaction that can be used to read and write documents. Firestore does not allow 3rd party auth requests to create read-write. transactions. # The transaction can be used for both read and write operations.
&quot;retryTransaction&quot;: &quot;A String&quot;, # An optional transaction to retry.
},
},
Expand Down Expand Up @@ -524,7 +524,7 @@ <h3>Method Details</h3>
&quot;readOnly&quot;: { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents at the given time. This may not be older than 60 seconds.
},
&quot;readWrite&quot;: { # Options for a transaction that can be used to read and write documents. # The transaction can be used for both read and write operations.
&quot;readWrite&quot;: { # Options for a transaction that can be used to read and write documents. Firestore does not allow 3rd party auth requests to create read-write. transactions. # The transaction can be used for both read and write operations.
&quot;retryTransaction&quot;: &quot;A String&quot;, # An optional transaction to retry.
},
},
Expand Down Expand Up @@ -1754,7 +1754,7 @@ <h3>Method Details</h3>
&quot;readOnly&quot;: { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents at the given time. This may not be older than 60 seconds.
},
&quot;readWrite&quot;: { # Options for a transaction that can be used to read and write documents. # The transaction can be used for both read and write operations.
&quot;readWrite&quot;: { # Options for a transaction that can be used to read and write documents. Firestore does not allow 3rd party auth requests to create read-write. transactions. # The transaction can be used for both read and write operations.
&quot;retryTransaction&quot;: &quot;A String&quot;, # An optional transaction to retry.
},
},
Expand Down Expand Up @@ -1955,7 +1955,7 @@ <h3>Method Details</h3>
&quot;readOnly&quot;: { # Options for a transaction that can only be used to read documents. # The transaction can only be used for read operations.
&quot;readTime&quot;: &quot;A String&quot;, # Reads documents at the given time. This may not be older than 60 seconds.
},
&quot;readWrite&quot;: { # Options for a transaction that can be used to read and write documents. # The transaction can be used for both read and write operations.
&quot;readWrite&quot;: { # Options for a transaction that can be used to read and write documents. Firestore does not allow 3rd party auth requests to create read-write. transactions. # The transaction can be used for both read and write operations.
&quot;retryTransaction&quot;: &quot;A String&quot;, # An optional transaction to retry.
},
},
Expand Down
2 changes: 1 addition & 1 deletion docs/dyn/firestore_v1.projects.databases.html
Expand Up @@ -153,7 +153,7 @@ <h3>Method Details</h3>
&quot;versionRetentionPeriod&quot;: &quot;A String&quot;, # Output only. The period during which past versions of data are retained in the database. Any read or query can specify a `read_time` within this window, and will read the state of the database at that time. If the PITR feature is enabled, the retention period is 7 days. Otherwise, the retention period is 1 hour.
}

databaseId: string, Required. The ID to use for the database, which will become the final component of the database&#x27;s resource name. The value must be set to &quot;(default)&quot;.
databaseId: string, Required. The ID to use for the database, which will become the final component of the database&#x27;s resource name. This value should be 4-63 characters. Valid characters are /a-z-/ with first character a letter and the last a letter or a number. Must not be UUID-like /[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}/. &quot;(default)&quot; database id is also valid.
x__xgafv: string, V1 error format.
Allowed values
1 - v1 error format
Expand Down

0 comments on commit 9999852

Please sign in to comment.