google-cloud-datastore 1.8.2 → 2.0.0

data/lib/google/cloud/datastore/v1/doc/google/datastore/v1/query.rb

@@ -1,297 +0,0 @@
-# Copyright 2020 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 Datastore
-    module V1
-      # The result of fetching an entity from Datastore.
-      # @!attribute [rw] entity
-      #   @return [Google::Datastore::V1::Entity]
-      #     The resulting entity.
-      # @!attribute [rw] version
-      #   @return [Integer]
-      #     The version of the entity, a strictly positive number that monotonically
-      #     increases with changes to the entity.
-      #
-      #     This field is set for {Google::Datastore::V1::EntityResult::ResultType::FULL `FULL`} entity
-      #     results.
-      #
-      #     For {Google::Datastore::V1::LookupResponse#missing missing} entities in `LookupResponse`, this
-      #     is the version of the snapshot that was used to look up the entity, and it
-      #     is always set except for eventually consistent reads.
-      # @!attribute [rw] cursor
-      #   @return [String]
-      #     A cursor that points to the position after the result entity.
-      #     Set only when the `EntityResult` is part of a `QueryResultBatch` message.
-      class EntityResult
-        # Specifies what data the 'entity' field contains.
-        # A `ResultType` is either implied (for example, in `LookupResponse.missing`
-        # from `datastore.proto`, it is always `KEY_ONLY`) or specified by context
-        # (for example, in message `QueryResultBatch`, field `entity_result_type`
-        # specifies a `ResultType` for all the values in field `entity_results`).
-        module ResultType
-          # Unspecified. This value is never used.
-          RESULT_TYPE_UNSPECIFIED = 0
-
-          # The key and properties.
-          FULL = 1
-
-          # A projected subset of properties. The entity may have no key.
-          PROJECTION = 2
-
-          # Only the key.
-          KEY_ONLY = 3
-        end
-      end
-
-      # A query for entities.
-      # @!attribute [rw] projection
-      #   @return [Array<Google::Datastore::V1::Projection>]
-      #     The projection to return. Defaults to returning all properties.
-      # @!attribute [rw] kind
-      #   @return [Array<Google::Datastore::V1::KindExpression>]
-      #     The kinds to query (if empty, returns entities of all kinds).
-      #     Currently at most 1 kind may be specified.
-      # @!attribute [rw] filter
-      #   @return [Google::Datastore::V1::Filter]
-      #     The filter to apply.
-      # @!attribute [rw] order
-      #   @return [Array<Google::Datastore::V1::PropertyOrder>]
-      #     The order to apply to the query results (if empty, order is unspecified).
-      # @!attribute [rw] distinct_on
-      #   @return [Array<Google::Datastore::V1::PropertyReference>]
-      #     The properties to make distinct. The query results will contain the first
-      #     result for each distinct combination of values for the given properties
-      #     (if empty, all results are returned).
-      # @!attribute [rw] start_cursor
-      #   @return [String]
-      #     A starting point for the query results. Query cursors are
-      #     returned in query result batches and
-      #     [can only be used to continue the same
-      #     query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
-      # @!attribute [rw] end_cursor
-      #   @return [String]
-      #     An ending point for the query results. Query cursors are
-      #     returned in query result batches and
-      #     [can only be used to limit the same
-      #     query](https://cloud.google.com/datastore/docs/concepts/queries#cursors_limits_and_offsets).
-      # @!attribute [rw] offset
-      #   @return [Integer]
-      #     The number of results to skip. Applies before limit, but after all other
-      #     constraints. Optional. Must be >= 0 if specified.
-      # @!attribute [rw] limit
-      #   @return [Google::Protobuf::Int32Value]
-      #     The maximum number of results to return. Applies after all other
-      #     constraints. Optional.
-      #     Unspecified is interpreted as no limit.
-      #     Must be >= 0 if specified.
-      class Query; end
-
-      # A representation of a kind.
-      # @!attribute [rw] name
-      #   @return [String]
-      #     The name of the kind.
-      class KindExpression; end
-
-      # A reference to a property relative to the kind expressions.
-      # @!attribute [rw] name
-      #   @return [String]
-      #     The name of the property.
-      #     If name includes "."s, it may be interpreted as a property name path.
-      class PropertyReference; end
-
-      # A representation of a property in a projection.
-      # @!attribute [rw] property
-      #   @return [Google::Datastore::V1::PropertyReference]
-      #     The property to project.
-      class Projection; end
-
-      # The desired order for a specific property.
-      # @!attribute [rw] property
-      #   @return [Google::Datastore::V1::PropertyReference]
-      #     The property to order by.
-      # @!attribute [rw] direction
-      #   @return [Google::Datastore::V1::PropertyOrder::Direction]
-      #     The direction to order by. Defaults to `ASCENDING`.
-      class PropertyOrder
-        # The sort direction.
-        module Direction
-          # Unspecified. This value must not be used.
-          DIRECTION_UNSPECIFIED = 0
-
-          # Ascending.
-          ASCENDING = 1
-
-          # Descending.
-          DESCENDING = 2
-        end
-      end
-
-      # A holder for any type of filter.
-      # @!attribute [rw] composite_filter
-      #   @return [Google::Datastore::V1::CompositeFilter]
-      #     A composite filter.
-      # @!attribute [rw] property_filter
-      #   @return [Google::Datastore::V1::PropertyFilter]
-      #     A filter on a property.
-      class Filter; end
-
-      # A filter that merges multiple other filters using the given operator.
-      # @!attribute [rw] op
-      #   @return [Google::Datastore::V1::CompositeFilter::Operator]
-      #     The operator for combining multiple filters.
-      # @!attribute [rw] filters
-      #   @return [Array<Google::Datastore::V1::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 property.
-      # @!attribute [rw] property
-      #   @return [Google::Datastore::V1::PropertyReference]
-      #     The property to filter by.
-      # @!attribute [rw] op
-      #   @return [Google::Datastore::V1::PropertyFilter::Operator]
-      #     The operator to filter by.
-      # @!attribute [rw] value
-      #   @return [Google::Datastore::V1::Value]
-      #     The value to compare the property to.
-      class PropertyFilter
-        # A property filter operator.
-        module Operator
-          # Unspecified. This value must not be used.
-          OPERATOR_UNSPECIFIED = 0
-
-          # Less than.
-          LESS_THAN = 1
-
-          # Less than or equal.
-          LESS_THAN_OR_EQUAL = 2
-
-          # Greater than.
-          GREATER_THAN = 3
-
-          # Greater than or equal.
-          GREATER_THAN_OR_EQUAL = 4
-
-          # Equal.
-          EQUAL = 5
-
-          # Has ancestor.
-          HAS_ANCESTOR = 11
-        end
-      end
-
-      # A [GQL
-      # query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
-      # @!attribute [rw] query_string
-      #   @return [String]
-      #     A string of the format described
-      #     [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
-      # @!attribute [rw] allow_literals
-      #   @return [true, false]
-      #     When false, the query string must not contain any literals and instead must
-      #     bind all values. For example,
-      #     `SELECT * FROM Kind WHERE a = 'string literal'` is not allowed, while
-      #     `SELECT * FROM Kind WHERE a = @value` is.
-      # @!attribute [rw] named_bindings
-      #   @return [Hash{String => Google::Datastore::V1::GqlQueryParameter}]
-      #     For each non-reserved named binding site in the query string, there must be
-      #     a named parameter with that name, but not necessarily the inverse.
-      #
-      #     Key must match regex `[A-Za-z_$][A-Za-z_$0-9]*`, must not match regex
-      #     `__.*__`, and must not be `""`.
-      # @!attribute [rw] positional_bindings
-      #   @return [Array<Google::Datastore::V1::GqlQueryParameter>]
-      #     Numbered binding site @1 references the first numbered parameter,
-      #     effectively using 1-based indexing, rather than the usual 0.
-      #
-      #     For each binding site numbered i in `query_string`, there must be an i-th
-      #     numbered parameter. The inverse must also be true.
-      class GqlQuery; end
-
-      # A binding parameter for a GQL query.
-      # @!attribute [rw] value
-      #   @return [Google::Datastore::V1::Value]
-      #     A value parameter.
-      # @!attribute [rw] cursor
-      #   @return [String]
-      #     A query cursor. Query cursors are returned in query
-      #     result batches.
-      class GqlQueryParameter; end
-
-      # A batch of results produced by a query.
-      # @!attribute [rw] skipped_results
-      #   @return [Integer]
-      #     The number of results skipped, typically because of an offset.
-      # @!attribute [rw] skipped_cursor
-      #   @return [String]
-      #     A cursor that points to the position after the last skipped result.
-      #     Will be set when `skipped_results` != 0.
-      # @!attribute [rw] entity_result_type
-      #   @return [Google::Datastore::V1::EntityResult::ResultType]
-      #     The result type for every entity in `entity_results`.
-      # @!attribute [rw] entity_results
-      #   @return [Array<Google::Datastore::V1::EntityResult>]
-      #     The results for this batch.
-      # @!attribute [rw] end_cursor
-      #   @return [String]
-      #     A cursor that points to the position after the last result in the batch.
-      # @!attribute [rw] more_results
-      #   @return [Google::Datastore::V1::QueryResultBatch::MoreResultsType]
-      #     The state of the query after the current batch.
-      # @!attribute [rw] snapshot_version
-      #   @return [Integer]
-      #     The version number of the snapshot this batch was returned from.
-      #     This applies to the range of results from the query's `start_cursor` (or
-      #     the beginning of the query if no cursor was given) to this batch's
-      #     `end_cursor` (not the query's `end_cursor`).
-      #
-      #     In a single transaction, subsequent query result batches for the same query
-      #     can have a greater snapshot version number. Each batch's snapshot version
-      #     is valid for all preceding batches.
-      #     The value will be zero for eventually consistent queries.
-      class QueryResultBatch
-        # The possible values for the `more_results` field.
-        module MoreResultsType
-          # Unspecified. This value is never used.
-          MORE_RESULTS_TYPE_UNSPECIFIED = 0
-
-          # There may be additional batches to fetch from this query.
-          NOT_FINISHED = 1
-
-          # The query is finished, but there may be more results after the limit.
-          MORE_RESULTS_AFTER_LIMIT = 2
-
-          # The query is finished, but there may be more results after the end
-          # cursor.
-          MORE_RESULTS_AFTER_CURSOR = 4
-
-          # The query is finished, and there are no more results.
-          NO_MORE_RESULTS = 3
-        end
-      end
-    end
-  end
-end

data/lib/google/cloud/datastore/v1/doc/google/protobuf/struct.rb

@@ -1,74 +0,0 @@
-# Copyright 2018 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
-    # `Struct` represents a structured data value, consisting of fields
-    # which map to dynamically typed values. In some languages, `Struct`
-    # might be supported by a native representation. For example, in
-    # scripting languages like JS a struct is represented as an
-    # object. The details of that representation are described together
-    # with the proto support for the language.
-    #
-    # The JSON representation for `Struct` is JSON object.
-    # @!attribute [rw] fields
-    #   @return [Hash{String => Google::Protobuf::Value}]
-    #     Unordered map of dynamically typed values.
-    class Struct; end
-
-    # `Value` represents a dynamically typed value which can be either
-    # null, a number, a string, a boolean, a recursive struct value, or a
-    # list of values. A producer of value is expected to set one of that
-    # variants, absence of any variant indicates an error.
-    #
-    # The JSON representation for `Value` is JSON value.
-    # @!attribute [rw] null_value
-    #   @return [Google::Protobuf::NullValue]
-    #     Represents a null value.
-    # @!attribute [rw] number_value
-    #   @return [Float]
-    #     Represents a double value.
-    # @!attribute [rw] string_value
-    #   @return [String]
-    #     Represents a string value.
-    # @!attribute [rw] bool_value
-    #   @return [true, false]
-    #     Represents a boolean value.
-    # @!attribute [rw] struct_value
-    #   @return [Google::Protobuf::Struct]
-    #     Represents a structured value.
-    # @!attribute [rw] list_value
-    #   @return [Google::Protobuf::ListValue]
-    #     Represents a repeated +Value+.
-    class Value; end
-
-    # `ListValue` is a wrapper around a repeated field of values.
-    #
-    # The JSON representation for `ListValue` is JSON array.
-    # @!attribute [rw] values
-    #   @return [Array<Google::Protobuf::Value>]
-    #     Repeated field of dynamically typed values.
-    class ListValue; end
-
-    # `NullValue` is a singleton enumeration to represent the null value for the
-    # `Value` type union.
-    #
-    #  The JSON representation for `NullValue` is JSON +null+.
-    module NullValue
-      # Null value.
-      NULL_VALUE = 0
-    end
-  end
-end

data/lib/google/cloud/datastore/v1/doc/google/protobuf/timestamp.rb

@@ -1,109 +0,0 @@
-# Copyright 2018 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
-    # A Timestamp represents a point in time independent of any time zone
-    # or calendar, represented as seconds and fractions of seconds at
-    # nanosecond resolution in UTC Epoch time. It is encoded using the
-    # Proleptic Gregorian Calendar which extends the Gregorian calendar
-    # backwards to year one. It is encoded assuming all minutes are 60
-    # seconds long, i.e. leap seconds are "smeared" so that no leap second
-    # table is needed for interpretation. Range is from
-    # 0001-01-01T00:00:00Z to 9999-12-31T23:59:59.999999999Z.
-    # By restricting to that range, we ensure that we can convert to
-    # and from  RFC 3339 date strings.
-    # See [https://www.ietf.org/rfc/rfc3339.txt](https://www.ietf.org/rfc/rfc3339.txt).
-    #
-    # = Examples
-    #
-    # Example 1: Compute Timestamp from POSIX `time()`.
-    #
-    #     Timestamp timestamp;
-    #     timestamp.set_seconds(time(NULL));
-    #     timestamp.set_nanos(0);
-    #
-    # Example 2: Compute Timestamp from POSIX `gettimeofday()`.
-    #
-    #     struct timeval tv;
-    #     gettimeofday(&tv, NULL);
-    #
-    #     Timestamp timestamp;
-    #     timestamp.set_seconds(tv.tv_sec);
-    #     timestamp.set_nanos(tv.tv_usec * 1000);
-    #
-    # Example 3: Compute Timestamp from Win32 `GetSystemTimeAsFileTime()`.
-    #
-    #     FILETIME ft;
-    #     GetSystemTimeAsFileTime(&ft);
-    #     UINT64 ticks = (((UINT64)ft.dwHighDateTime) << 32) | ft.dwLowDateTime;
-    #
-    #     // A Windows tick is 100 nanoseconds. Windows epoch 1601-01-01T00:00:00Z
-    #     // is 11644473600 seconds before Unix epoch 1970-01-01T00:00:00Z.
-    #     Timestamp timestamp;
-    #     timestamp.set_seconds((INT64) ((ticks / 10000000) - 11644473600LL));
-    #     timestamp.set_nanos((INT32) ((ticks % 10000000) * 100));
-    #
-    # Example 4: Compute Timestamp from Java `System.currentTimeMillis()`.
-    #
-    #     long millis = System.currentTimeMillis();
-    #
-    #     Timestamp timestamp = Timestamp.newBuilder().setSeconds(millis / 1000)
-    #         .setNanos((int) ((millis % 1000) * 1000000)).build();
-    #
-    #
-    # Example 5: Compute Timestamp from current time in Python.
-    #
-    #     timestamp = Timestamp()
-    #     timestamp.GetCurrentTime()
-    #
-    # = JSON Mapping
-    #
-    # In JSON format, the Timestamp type is encoded as a string in the
-    # [RFC 3339](https://www.ietf.org/rfc/rfc3339.txt) format. That is, the
-    # format is "\\{year}-\\{month}-\\{day}T\\{hour}:\\{min}:\\{sec}[.\\{frac_sec}]Z"
-    # where \\{year} is always expressed using four digits while \\{month}, \\{day},
-    # \\{hour}, \\{min}, and \\{sec} are zero-padded to two digits each. The fractional
-    # seconds, which can go up to 9 digits (i.e. up to 1 nanosecond resolution),
-    # are optional. The "Z" suffix indicates the timezone ("UTC"); the timezone
-    # is required. A proto3 JSON serializer should always use UTC (as indicated by
-    # "Z") when printing the Timestamp type and a proto3 JSON parser should be
-    # able to accept both UTC and other timezones (as indicated by an offset).
-    #
-    # For example, "2017-01-15T01:30:15.01Z" encodes 15.01 seconds past
-    # 01:30 UTC on January 15, 2017.
-    #
-    # In JavaScript, one can convert a Date object to this format using the
-    # standard [toISOString()](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date/toISOString)
-    # method. In Python, a standard `datetime.datetime` object can be converted
-    # to this format using [`strftime`](https://docs.python.org/2/library/time.html#time.strftime)
-    # with the time format spec '%Y-%m-%dT%H:%M:%S.%fZ'. Likewise, in Java, one
-    # can use the Joda Time's [`ISODateTimeFormat.dateTime()`](
-    # http://www.joda.org/joda-time/apidocs/org/joda/time/format/ISODateTimeFormat.html#dateTime--
-    # ) to obtain a formatter capable of generating timestamps in this format.
-    # @!attribute [rw] seconds
-    #   @return [Integer]
-    #     Represents seconds of UTC time since Unix epoch
-    #     1970-01-01T00:00:00Z. Must be from 0001-01-01T00:00:00Z to
-    #     9999-12-31T23:59:59Z inclusive.
-    # @!attribute [rw] nanos
-    #   @return [Integer]
-    #     Non-negative fractions of a second at nanosecond resolution. Negative
-    #     second values with fractions must still have non-negative nanos values
-    #     that count forward in time. Must be from 0 to 999,999,999
-    #     inclusive.
-    class Timestamp; end
-  end
-end