Skip to content

Commit

Permalink
chore: expand Target.target_id docs
Browse files Browse the repository at this point in the history
chore: improve FieldReference.field_path docs
chore: (preview only) expose Query Profile API

PiperOrigin-RevId: 570489360
  • Loading branch information
Google APIs authored and Copybara-Service committed Oct 3, 2023
1 parent 41157b4 commit 5c5f6b7
Show file tree
Hide file tree
Showing 3 changed files with 19 additions and 14 deletions.
17 changes: 16 additions & 1 deletion google/firestore/v1/firestore.proto
Original file line number Diff line number Diff line change
Expand Up @@ -761,7 +761,7 @@ message PartitionQueryResponse {
// * query, start_at B
//
// An empty result may indicate that the query has too few results to be
// partitioned.
// partitioned, or that the query is not yet supported for partitioning.
repeated Cursor partitions = 1;

// A page token that may be used to request an additional set of results, up
Expand Down Expand Up @@ -944,6 +944,21 @@ message Target {

// The target ID that identifies the target on the stream. Must be a positive
// number and non-zero.
//
// If `target_id` is 0 (or unspecified), the server will assign an ID for this
// target and return that in a `TargetChange::ADD` event. Once a target with
// `target_id=0` is added, all subsequent targets must also have
// `target_id=0`. If an `AddTarget` request with `target_id != 0` is
// sent to the server after a target with `target_id=0` is added, the server
// will immediately send a response with a `TargetChange::Remove` event.
//
// Note that if the client sends multiple `AddTarget` requests
// without an ID, the order of IDs returned in `TargetChage.target_ids` are
// undefined. Therefore, clients should provide a target ID instead of relying
// on the server to assign one.
//
// If `target_id` is non-zero, there must not be an existing active target on
// this stream with the same ID.
int32 target_id = 5;

// If the target should be removed once it is current and consistent.
Expand Down
11 changes: 0 additions & 11 deletions google/firestore/v1/firestore_v1.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -19,17 +19,6 @@ documentation:
- selector: google.cloud.location.Locations.ListLocations
description: Lists information about the supported locations for this service.

backend:
rules:
- selector: google.cloud.location.Locations.GetLocation
deadline: 295.0
- selector: google.cloud.location.Locations.ListLocations
deadline: 295.0
- selector: 'google.firestore.v1.Firestore.*'
deadline: 295.0
- selector: 'google.longrunning.Operations.*'
deadline: 295.0

http:
rules:
- selector: google.longrunning.Operations.CancelOperation
Expand Down
5 changes: 3 additions & 2 deletions google/firestore/v1/query.proto
Original file line number Diff line number Diff line change
Expand Up @@ -236,11 +236,12 @@ message StructuredQuery {

// A reference to a field in a document, ex: `stats.operations`.
message FieldReference {
// The relative path of the document being referenced.
// A reference to a field in a document.
//
// Requires:
//
// * Conform to [document field name][google.firestore.v1.Document.fields]
// * MUST be a dot-delimited (`.`) string of segments, where each segment
// conforms to [document field name][google.firestore.v1.Document.fields]
// limitations.
string field_path = 2;
}
Expand Down

0 comments on commit 5c5f6b7

Please sign in to comment.