google-cloud-firestore 0.20.0

data/lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/query.rb

@@ -0,0 +1,215 @@
+# Copyright 2017 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Firestore
+    module V1beta1
+      # A Firestore query.
+      # @!attribute [rw] select
+      #   @return [Google::Firestore::V1beta1::StructuredQuery::Projection]
+      #     The projection to return.
+      # @!attribute [rw] from
+      #   @return [Array<Google::Firestore::V1beta1::StructuredQuery::CollectionSelector>]
+      #     The collections to query.
+      # @!attribute [rw] where
+      #   @return [Google::Firestore::V1beta1::StructuredQuery::Filter]
+      #     The filter to apply.
+      # @!attribute [rw] order_by
+      #   @return [Array<Google::Firestore::V1beta1::StructuredQuery::Order>]
+      #     The order to apply to the query results.
+      #
+      #     Firestore guarantees a stable ordering through the following rules:
+      #
+      #     * Any field required to appear in +order_by+, that is not already
+      #       specified in +order_by+, is appended to the order in field name order
+      #       by default.
+      #     * If an order on +__name__+ is not specified, it is appended by default.
+      #
+      #     Fields are appended with the same sort direction as the last order
+      #     specified, or 'ASCENDING' if no order was specified. For example:
+      #
+      #     * +SELECT * FROM Foo ORDER BY A+ becomes
+      #       +SELECT * FROM Foo ORDER BY A, __name__+
+      #     * +SELECT * FROM Foo ORDER BY A DESC+ becomes
+      #       +SELECT * FROM Foo ORDER BY A DESC, __name__ DESC+
+      #     * +SELECT * FROM Foo WHERE A > 1+ becomes
+      #       +SELECT * FROM Foo WHERE A > 1 ORDER BY A, __name__+
+      # @!attribute [rw] start_at
+      #   @return [Google::Firestore::V1beta1::Cursor]
+      #     A starting point for the query results.
+      # @!attribute [rw] end_at
+      #   @return [Google::Firestore::V1beta1::Cursor]
+      #     A end point for the query results.
+      # @!attribute [rw] offset
+      #   @return [Integer]
+      #     The number of results to skip.
+      #
+      #     Applies before limit, but after all other constraints. Must be >= 0 if
+      #     specified.
+      # @!attribute [rw] limit
+      #   @return [Google::Protobuf::Int32Value]
+      #     The maximum number of results to return.
+      #
+      #     Applies after all other constraints.
+      #     Must be >= 0 if specified.
+      class StructuredQuery
+        # A selection of a collection, such as +messages as m1+.
+        # @!attribute [rw] collection_id
+        #   @return [String]
+        #     The collection ID.
+        #     When set, selects only collections with this ID.
+        # @!attribute [rw] all_descendants
+        #   @return [true, false]
+        #     When false, selects only collections that are immediate children of
+        #     the +parent+ specified in the containing +RunQueryRequest+.
+        #     When true, selects all descendant collections.
+        class CollectionSelector; end
+
+        # A filter.
+        # @!attribute [rw] composite_filter
+        #   @return [Google::Firestore::V1beta1::StructuredQuery::CompositeFilter]
+        #     A composite filter.
+        # @!attribute [rw] field_filter
+        #   @return [Google::Firestore::V1beta1::StructuredQuery::FieldFilter]
+        #     A filter on a document field.
+        # @!attribute [rw] unary_filter
+        #   @return [Google::Firestore::V1beta1::StructuredQuery::UnaryFilter]
+        #     A filter that takes exactly one argument.
+        class Filter; end
+
+        # A filter that merges multiple other filters using the given operator.
+        # @!attribute [rw] op
+        #   @return [Google::Firestore::V1beta1::StructuredQuery::CompositeFilter::Operator]
+        #     The operator for combining multiple filters.
+        # @!attribute [rw] filters
+        #   @return [Array<Google::Firestore::V1beta1::StructuredQuery::Filter>]
+        #     The list of filters to combine.
+        #     Must contain at least one filter.
+        class CompositeFilter
+          # A composite filter operator.
+          module Operator
+            # Unspecified. This value must not be used.
+            OPERATOR_UNSPECIFIED = 0
+
+            # The results are required to satisfy each of the combined filters.
+            AND = 1
+          end
+        end
+
+        # A filter on a specific field.
+        # @!attribute [rw] field
+        #   @return [Google::Firestore::V1beta1::StructuredQuery::FieldReference]
+        #     The field to filter by.
+        # @!attribute [rw] op
+        #   @return [Google::Firestore::V1beta1::StructuredQuery::FieldFilter::Operator]
+        #     The operator to filter by.
+        # @!attribute [rw] value
+        #   @return [Google::Firestore::V1beta1::Value]
+        #     The value to compare to.
+        class FieldFilter
+          # A field filter operator.
+          module Operator
+            # Unspecified. This value must not be used.
+            OPERATOR_UNSPECIFIED = 0
+
+            # Less than. Requires that the field come first in +order_by+.
+            LESS_THAN = 1
+
+            # Less than or equal. Requires that the field come first in +order_by+.
+            LESS_THAN_OR_EQUAL = 2
+
+            # Greater than. Requires that the field come first in +order_by+.
+            GREATER_THAN = 3
+
+            # Greater than or equal. Requires that the field come first in
+            # +order_by+.
+            GREATER_THAN_OR_EQUAL = 4
+
+            # Equal.
+            EQUAL = 5
+          end
+        end
+
+        # A filter with a single operand.
+        # @!attribute [rw] op
+        #   @return [Google::Firestore::V1beta1::StructuredQuery::UnaryFilter::Operator]
+        #     The unary operator to apply.
+        # @!attribute [rw] field
+        #   @return [Google::Firestore::V1beta1::StructuredQuery::FieldReference]
+        #     The field to which to apply the operator.
+        class UnaryFilter
+          # A unary operator.
+          module Operator
+            # Unspecified. This value must not be used.
+            OPERATOR_UNSPECIFIED = 0
+
+            # Test if a field is equal to NaN.
+            IS_NAN = 2
+
+            # Test if an exprestion evaluates to Null.
+            IS_NULL = 3
+          end
+        end
+
+        # An order on a field.
+        # @!attribute [rw] field
+        #   @return [Google::Firestore::V1beta1::StructuredQuery::FieldReference]
+        #     The field to order by.
+        # @!attribute [rw] direction
+        #   @return [Google::Firestore::V1beta1::StructuredQuery::Direction]
+        #     The direction to order by. Defaults to +ASCENDING+.
+        class Order; end
+
+        # A reference to a field, such as +max(messages.time) as max_time+.
+        # @!attribute [rw] field_path
+        #   @return [String]
+        class FieldReference; end
+
+        # The projection of document's fields to return.
+        # @!attribute [rw] fields
+        #   @return [Array<Google::Firestore::V1beta1::StructuredQuery::FieldReference>]
+        #     The fields to return.
+        #
+        #     If empty, all fields are returned. To only return the name
+        #     of the document, use +['__name__']+.
+        class Projection; end
+
+        # A sort direction.
+        module Direction
+          # Unspecified.
+          DIRECTION_UNSPECIFIED = 0
+
+          # Ascending.
+          ASCENDING = 1
+
+          # Descending.
+          DESCENDING = 2
+        end
+      end
+
+      # A position in a query result set.
+      # @!attribute [rw] values
+      #   @return [Array<Google::Firestore::V1beta1::Value>]
+      #     The values that represent a position, in the order they appear in
+      #     the order by clause of a query.
+      #
+      #     Can contain fewer values than specified in the order by clause.
+      # @!attribute [rw] before
+      #   @return [true, false]
+      #     If the position is just before or just after the given values, relative
+      #     to the sort order defined by the query.
+      class Cursor; end
+    end
+  end
+end

data/lib/google/cloud/firestore/v1beta1/doc/google/firestore/v1beta1/write.rb

@@ -0,0 +1,167 @@
+# Copyright 2017 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Firestore
+    module V1beta1
+      # A write on a document.
+      # @!attribute [rw] update
+      #   @return [Google::Firestore::V1beta1::Document]
+      #     A document to write.
+      # @!attribute [rw] delete
+      #   @return [String]
+      #     A document name to delete. In the format:
+      #     +projects/{project_id}/databases/{database_id}/documents/{document_path}+.
+      # @!attribute [rw] transform
+      #   @return [Google::Firestore::V1beta1::DocumentTransform]
+      #     Applies a tranformation to a document.
+      #     At most one +transform+ per document is allowed in a given request.
+      #     An +update+ cannot follow a +transform+ on the same document in a given
+      #     request.
+      # @!attribute [rw] update_mask
+      #   @return [Google::Firestore::V1beta1::DocumentMask]
+      #     The fields to update in this write.
+      #
+      #     This field can be set only when the operation is +update+.
+      #     None of the field paths in the mask may contain a reserved name.
+      #     If the document exists on the server and has fields not referenced in the
+      #     mask, they are left unchanged.
+      #     Fields referenced in the mask, but not present in the input document, are
+      #     deleted from the document on the server.
+      #     The field paths in this mask must not contain a reserved field name.
+      # @!attribute [rw] current_document
+      #   @return [Google::Firestore::V1beta1::Precondition]
+      #     An optional precondition on the document.
+      #
+      #     The write will fail if this is set and not met by the target document.
+      class Write; end
+
+      # A transformation of a document.
+      # @!attribute [rw] document
+      #   @return [String]
+      #     The name of the document to transform.
+      # @!attribute [rw] field_transforms
+      #   @return [Array<Google::Firestore::V1beta1::DocumentTransform::FieldTransform>]
+      #     The list of transformations to apply to the fields of the document, in
+      #     order.
+      class DocumentTransform
+        # A transformation of a field of the document.
+        # @!attribute [rw] field_path
+        #   @return [String]
+        #     The path of the field. See {Google::Firestore::V1beta1::Document#fields Document#fields} for the field path syntax
+        #     reference.
+        # @!attribute [rw] set_to_server_value
+        #   @return [Google::Firestore::V1beta1::DocumentTransform::FieldTransform::ServerValue]
+        #     Sets the field to the given server value.
+        class FieldTransform
+          # A value that is calculated by the server.
+          module ServerValue
+            # Unspecified. This value must not be used.
+            SERVER_VALUE_UNSPECIFIED = 0
+
+            # The time at which the server processed the request.
+            REQUEST_TIME = 1
+          end
+        end
+      end
+
+      # The result of applying a write.
+      # @!attribute [rw] update_time
+      #   @return [Google::Protobuf::Timestamp]
+      #     The last update time of the document after applying the write. Not set
+      #     after a +delete+.
+      #
+      #     If the write did not actually change the document, this will be the
+      #     previous update_time.
+      # @!attribute [rw] transform_results
+      #   @return [Array<Google::Firestore::V1beta1::Value>]
+      #     The results of applying each {Google::Firestore::V1beta1::DocumentTransform::FieldTransform DocumentTransform::FieldTransform}, in the
+      #     same order.
+      class WriteResult; end
+
+      # A {Google::Firestore::V1beta1::Document Document} has changed.
+      #
+      # May be the result of multiple {Google::Firestore::V1beta1::Write Writes}, including deletes, that
+      # ultimately resulted in a new value for the {Google::Firestore::V1beta1::Document Document}.
+      #
+      # Multiple {Google::Firestore::V1beta1::DocumentChange DocumentChange} messages may be returned for the same logical
+      # change, if multiple targets are affected.
+      # @!attribute [rw] document
+      #   @return [Google::Firestore::V1beta1::Document]
+      #     The new state of the {Google::Firestore::V1beta1::Document Document}.
+      #
+      #     If +mask+ is set, contains only fields that were updated or added.
+      # @!attribute [rw] target_ids
+      #   @return [Array<Integer>]
+      #     A set of target IDs of targets that match this document.
+      # @!attribute [rw] removed_target_ids
+      #   @return [Array<Integer>]
+      #     A set of target IDs for targets that no longer match this document.
+      class DocumentChange; end
+
+      # A {Google::Firestore::V1beta1::Document Document} has been deleted.
+      #
+      # May be the result of multiple {Google::Firestore::V1beta1::Write Writes}, including updates, the
+      # last of which deleted the {Google::Firestore::V1beta1::Document Document}.
+      #
+      # Multiple {Google::Firestore::V1beta1::DocumentDelete DocumentDelete} messages may be returned for the same logical
+      # delete, if multiple targets are affected.
+      # @!attribute [rw] document
+      #   @return [String]
+      #     The resource name of the {Google::Firestore::V1beta1::Document Document} that was deleted.
+      # @!attribute [rw] removed_target_ids
+      #   @return [Array<Integer>]
+      #     A set of target IDs for targets that previously matched this entity.
+      # @!attribute [rw] read_time
+      #   @return [Google::Protobuf::Timestamp]
+      #     The read timestamp at which the delete was observed.
+      #
+      #     Greater or equal to the +commit_time+ of the delete.
+      class DocumentDelete; end
+
+      # A {Google::Firestore::V1beta1::Document Document} has been removed from the view of the targets.
+      #
+      # Sent if the document is no longer relevant to a target and is out of view.
+      # Can be sent instead of a DocumentDelete or a DocumentChange if the server
+      # can not send the new value of the document.
+      #
+      # Multiple {Google::Firestore::V1beta1::DocumentRemove DocumentRemove} messages may be returned for the same logical
+      # write or delete, if multiple targets are affected.
+      # @!attribute [rw] document
+      #   @return [String]
+      #     The resource name of the {Google::Firestore::V1beta1::Document Document} that has gone out of view.
+      # @!attribute [rw] removed_target_ids
+      #   @return [Array<Integer>]
+      #     A set of target IDs for targets that previously matched this document.
+      # @!attribute [rw] read_time
+      #   @return [Google::Protobuf::Timestamp]
+      #     The read timestamp at which the remove was observed.
+      #
+      #     Greater or equal to the +commit_time+ of the change/delete/remove.
+      class DocumentRemove; end
+
+      # A digest of all the documents that match a given target.
+      # @!attribute [rw] target_id
+      #   @return [Integer]
+      #     The target ID to which this filter applies.
+      # @!attribute [rw] count
+      #   @return [Integer]
+      #     The total count of documents that match {Google::Firestore::V1beta1::ExistenceFilter#target_id Target_id}.
+      #
+      #     If different from the count of documents in the client that match, the
+      #     client must manually determine which documents no longer match the target.
+      class ExistenceFilter; end
+    end
+  end
+end

data/lib/google/cloud/firestore/v1beta1/doc/google/protobuf/any.rb

@@ -0,0 +1,124 @@
+# Copyright 2017 Google LLC
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+module Google
+  module Protobuf
+    # +Any+ contains an arbitrary serialized protocol buffer message along with a
+    # URL that describes the type of the serialized message.
+    #
+    # Protobuf library provides support to pack/unpack Any values in the form
+    # of utility functions or additional generated methods of the Any type.
+    #
+    # Example 1: Pack and unpack a message in C++.
+    #
+    #     Foo foo = ...;
+    #     Any any;
+    #     any.PackFrom(foo);
+    #     ...
+    #     if (any.UnpackTo(&foo)) {
+    #       ...
+    #     }
+    #
+    # Example 2: Pack and unpack a message in Java.
+    #
+    #     Foo foo = ...;
+    #     Any any = Any.pack(foo);
+    #     ...
+    #     if (any.is(Foo.class)) {
+    #       foo = any.unpack(Foo.class);
+    #     }
+    #
+    #  Example 3: Pack and unpack a message in Python.
+    #
+    #     foo = Foo(...)
+    #     any = Any()
+    #     any.Pack(foo)
+    #     ...
+    #     if any.Is(Foo.DESCRIPTOR):
+    #       any.Unpack(foo)
+    #       ...
+    #
+    #  Example 4: Pack and unpack a message in Go
+    #
+    #      foo := &pb.Foo{...}
+    #      any, err := ptypes.MarshalAny(foo)
+    #      ...
+    #      foo := &pb.Foo{}
+    #      if err := ptypes.UnmarshalAny(any, foo); err != nil {
+    #        ...
+    #      }
+    #
+    # The pack methods provided by protobuf library will by default use
+    # 'type.googleapis.com/full.type.name' as the type URL and the unpack
+    # methods only use the fully qualified type name after the last '/'
+    # in the type URL, for example "foo.bar.com/x/y.z" will yield type
+    # name "y.z".
+    #
+    #
+    # = JSON
+    #
+    # The JSON representation of an +Any+ value uses the regular
+    # representation of the deserialized, embedded message, with an
+    # additional field +@type+ which contains the type URL. Example:
+    #
+    #     package google.profile;
+    #     message Person {
+    #       string first_name = 1;
+    #       string last_name = 2;
+    #     }
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.profile.Person",
+    #       "firstName": <string>,
+    #       "lastName": <string>
+    #     }
+    #
+    # If the embedded message type is well-known and has a custom JSON
+    # representation, that representation will be embedded adding a field
+    # +value+ which holds the custom JSON in addition to the +@type+
+    # field. Example (for message {Google::Protobuf::Duration}):
+    #
+    #     {
+    #       "@type": "type.googleapis.com/google.protobuf.Duration",
+    #       "value": "1.212s"
+    #     }
+    # @!attribute [rw] type_url
+    #   @return [String]
+    #     A URL/resource name whose content describes the type of the
+    #     serialized protocol buffer message.
+    #
+    #     For URLs which use the scheme +http+, +https+, or no scheme, the
+    #     following restrictions and interpretations apply:
+    #
+    #     * If no scheme is provided, +https+ is assumed.
+    #     * The last segment of the URL's path must represent the fully
+    #       qualified name of the type (as in +path/google.protobuf.Duration+).
+    #       The name should be in a canonical form (e.g., leading "." is
+    #       not accepted).
+    #     * An HTTP GET on the URL must yield a {Google::Protobuf::Type}
+    #       value in binary format, or produce an error.
+    #     * Applications are allowed to cache lookup results based on the
+    #       URL, or have them precompiled into a binary to avoid any
+    #       lookup. Therefore, binary compatibility needs to be preserved
+    #       on changes to types. (Use versioned type names to manage
+    #       breaking changes.)
+    #
+    #     Schemes other than +http+, +https+ (or the empty scheme) might be
+    #     used with implementation specific semantics.
+    # @!attribute [rw] value
+    #   @return [String]
+    #     Must be a valid serialized protocol buffer of the above specified type.
+    class Any; end
+  end
+end