Skip to content

feat: add RequestOptions and request_options to Firestore v1 protos #35073

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
torreypayne merged 2 commits into from
Jul 31, 2026
Merged

feat: add RequestOptions and request_options to Firestore v1 protos #35073

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
554be80
feat: add RequestOptions and request_options to Firestore v1 protos
gcf-owl-bot[bot] Jul 31, 2026
ca67699
🦉 Updates from OwlBot post-processor
gcf-owl-bot[bot] Jul 31, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
60 changes: 45 additions & 15 deletions google-cloud-firestore-v1/lib/google/cloud/firestore/v1/firestore/client.rb
View file
Open in desktop

Large diffs are not rendered by default.

60 changes: 45 additions & 15 deletions google-cloud-firestore-v1/lib/google/cloud/firestore/v1/firestore/rest/client.rb
View file
Open in desktop

Large diffs are not rendered by default.

3 changes: 2 additions & 1 deletion google-cloud-firestore-v1/lib/google/firestore/v1/common_pb.rb
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion google-cloud-firestore-v1/lib/google/firestore/v1/firestore_pb.rb
View file
Open in desktop

Large diffs are not rendered by default.

9 changes: 9 additions & 0 deletions google-cloud-firestore-v1/proto_docs/google/firestore/v1/common.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -114,6 +114,15 @@ module ConcurrencyMode
PESSIMISTIC = 2
end
end

# Options for a server request.
# @!attribute [rw] request_tags
# @return [::Array<::String>]
# The request tags for the request.
class RequestOptions
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
end
end
end
end
Expand Down
51 changes: 51 additions & 0 deletions google-cloud-firestore-v1/proto_docs/google/firestore/v1/firestore.rb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,6 +47,9 @@ module V1
# minute timestamp within the past 7 days.
#
# Note: The following fields are mutually exclusive: `read_time`, `transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
# @!attribute [rw] request_options
# @return [::Google::Cloud::Firestore::V1::RequestOptions]
# Optional. Any additional options for the request.
class GetDocumentRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -123,6 +126,9 @@ class GetDocumentRequest
# {::Google::Cloud::Firestore::V1::Document#update_time `update_time`} set.
#
# Requests with `show_missing` may not specify `where` or `order_by`.
# @!attribute [rw] request_options
# @return [::Google::Cloud::Firestore::V1::RequestOptions]
# Optional. Any additional options for the request.
class ListDocumentsRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -168,6 +174,9 @@ class ListDocumentsResponse
#
# If the document has a field that is not present in this mask, that field
# will not be returned in the response.
# @!attribute [rw] request_options
# @return [::Google::Cloud::Firestore::V1::RequestOptions]
# Optional. Any additional options for the request.
class CreateDocumentRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -198,6 +207,9 @@ class CreateDocumentRequest
# @return [::Google::Cloud::Firestore::V1::Precondition]
# An optional precondition on the document.
# The request will fail if this is set and not met by the target document.
# @!attribute [rw] request_options
# @return [::Google::Cloud::Firestore::V1::RequestOptions]
# Optional. Any additional options for the request.
class UpdateDocumentRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand All @@ -213,6 +225,9 @@ class UpdateDocumentRequest
# @return [::Google::Cloud::Firestore::V1::Precondition]
# An optional precondition on the document.
# The request will fail if this is set and not met by the target document.
# @!attribute [rw] request_options
# @return [::Google::Cloud::Firestore::V1::RequestOptions]
# Optional. Any additional options for the request.
class DeleteDocumentRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -258,6 +273,9 @@ class DeleteDocumentRequest
# minute timestamp within the past 7 days.
#
# Note: The following fields are mutually exclusive: `read_time`, `transaction`, `new_transaction`. If a field in that set is populated, all other fields in the set will automatically be cleared.
# @!attribute [rw] request_options
# @return [::Google::Cloud::Firestore::V1::RequestOptions]
# Optional. Any additional options for the request.
class BatchGetDocumentsRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -303,6 +321,9 @@ class BatchGetDocumentsResponse
# @return [::Google::Cloud::Firestore::V1::TransactionOptions]
# The options for the transaction.
# Defaults to a read-write transaction.
# @!attribute [rw] request_options
# @return [::Google::Cloud::Firestore::V1::RequestOptions]
# Optional. Any additional options for the request.
class BeginTransactionRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -331,6 +352,9 @@ class BeginTransactionResponse
# @!attribute [rw] transaction
# @return [::String]
# If set, applies all writes in this transaction, and commits it.
# @!attribute [rw] request_options
# @return [::Google::Cloud::Firestore::V1::RequestOptions]
# Optional. Any additional options for the request.
class CommitRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -360,6 +384,9 @@ class CommitResponse
# @!attribute [rw] transaction
# @return [::String]
# Required. The transaction to roll back.
# @!attribute [rw] request_options
# @return [::Google::Cloud::Firestore::V1::RequestOptions]
# Optional. Any additional options for the request.
class RollbackRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -405,6 +432,9 @@ class RollbackRequest
# @return [::Google::Cloud::Firestore::V1::ExplainOptions]
# Optional. Explain options for the query. If set, additional query
# statistics will be returned. If not, only query results will be returned.
# @!attribute [rw] request_options
# @return [::Google::Cloud::Firestore::V1::RequestOptions]
# Optional. Any additional options for the request.
class RunQueryRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -487,6 +517,9 @@ class RunQueryResponse
# Optional. Automatically commits the transaction after the pipeline has been
# executed. Only permitted in combination with `transaction` or
# `new_transaction`.
# @!attribute [rw] request_options
# @return [::Google::Cloud::Firestore::V1::RequestOptions]
# Optional. Any additional options for the request.
class ExecutePipelineRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -581,6 +614,9 @@ class ExecutePipelineResponse
# @return [::Google::Cloud::Firestore::V1::ExplainOptions]
# Optional. Explain options for the query. If set, additional query
# statistics will be returned. If not, only query results will be returned.
# @!attribute [rw] request_options
# @return [::Google::Cloud::Firestore::V1::RequestOptions]
# Optional. Any additional options for the request.
class RunAggregationQueryRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -674,6 +710,9 @@ class RunAggregationQueryResponse
# This must be a microsecond precision timestamp within the past one hour,
# or if Point-in-Time Recovery is enabled, can additionally be a whole
# minute timestamp within the past 7 days.
# @!attribute [rw] request_options
# @return [::Google::Cloud::Firestore::V1::RequestOptions]
# Optional. Any additional options for the request.
class PartitionQueryRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -757,6 +796,9 @@ class PartitionQueryResponse
# @!attribute [rw] labels
# @return [::Google::Protobuf::Map{::String => ::String}]
# Labels associated with this write request.
# @!attribute [rw] request_options
# @return [::Google::Cloud::Firestore::V1::RequestOptions]
# Optional. Any additional options for the request.
class WriteRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -815,6 +857,9 @@ class WriteResponse
# @!attribute [rw] labels
# @return [::Google::Protobuf::Map{::String => ::String}]
# Labels associated with this target change.
# @!attribute [rw] request_options
# @return [::Google::Cloud::Firestore::V1::RequestOptions]
# Optional. Any additional options for the request.
class ListenRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -1046,6 +1091,9 @@ module TargetChangeType
# This must be a microsecond precision timestamp within the past one hour,
# or if Point-in-Time Recovery is enabled, can additionally be a whole
# minute timestamp within the past 7 days.
# @!attribute [rw] request_options
# @return [::Google::Cloud::Firestore::V1::RequestOptions]
# Optional. Any additional options for the request.
class ListCollectionIdsRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down Expand Up @@ -1080,6 +1128,9 @@ class ListCollectionIdsResponse
# @!attribute [rw] labels
# @return [::Google::Protobuf::Map{::String => ::String}]
# Labels associated with this batch write.
# @!attribute [rw] request_options
# @return [::Google::Cloud::Firestore::V1::RequestOptions]
# Optional. Any additional options for the request.
class BatchWriteRequest
include ::Google::Protobuf::MessageExts
extend ::Google::Protobuf::MessageExts::ClassMethods
Expand Down
Loading
Loading