# Copyright 2015 Google Inc. # # 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 # # http://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. require 'date' require 'google/apis/core/base_service' require 'google/apis/core/json_representation' require 'google/apis/core/hashable' require 'google/apis/errors' module Google module Apis module DatastoreV1 # The request for Datastore.AllocateIds. class AllocateIdsRequest include Google::Apis::Core::Hashable # Required. A list of keys with incomplete key paths for which to allocate IDs. # No key may be reserved/read-only. # Corresponds to the JSON property `keys` # @return [Array] attr_accessor :keys def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @keys = args[:keys] if args.key?(:keys) end end # The response for Datastore.AllocateIds. class AllocateIdsResponse include Google::Apis::Core::Hashable # The keys specified in the request (in the same order), each with its key path # completed with a newly allocated ID. # Corresponds to the JSON property `keys` # @return [Array] attr_accessor :keys def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @keys = args[:keys] if args.key?(:keys) end end # An array value. class ArrayValue include Google::Apis::Core::Hashable # Values in the array. The order of values in an array is preserved as long as # all values have identical settings for 'exclude_from_indexes'. # Corresponds to the JSON property `values` # @return [Array] attr_accessor :values def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @values = args[:values] if args.key?(:values) end end # The request for Datastore.BeginTransaction. class BeginTransactionRequest include Google::Apis::Core::Hashable # Options for beginning a new transaction. Transactions can be created # explicitly with calls to Datastore.BeginTransaction or implicitly by setting # ReadOptions.new_transaction in read requests. # Corresponds to the JSON property `transactionOptions` # @return [Google::Apis::DatastoreV1::TransactionOptions] attr_accessor :transaction_options def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @transaction_options = args[:transaction_options] if args.key?(:transaction_options) end end # The response for Datastore.BeginTransaction. class BeginTransactionResponse include Google::Apis::Core::Hashable # The transaction identifier (always present). # Corresponds to the JSON property `transaction` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :transaction def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @transaction = args[:transaction] if args.key?(:transaction) end end # The request for Datastore.Commit. class CommitRequest include Google::Apis::Core::Hashable # The type of commit to perform. Defaults to `TRANSACTIONAL`. # Corresponds to the JSON property `mode` # @return [String] attr_accessor :mode # The mutations to perform. When mode is `TRANSACTIONAL`, mutations affecting a # single entity are applied in order. The following sequences of mutations # affecting a single entity are not permitted in a single `Commit` request: - ` # insert` followed by `insert` - `update` followed by `insert` - `upsert` # followed by `insert` - `delete` followed by `update` When mode is ` # NON_TRANSACTIONAL`, no two mutations may affect a single entity. # Corresponds to the JSON property `mutations` # @return [Array] attr_accessor :mutations # The identifier of the transaction associated with the commit. A transaction # identifier is returned by a call to Datastore.BeginTransaction. # Corresponds to the JSON property `transaction` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :transaction def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @mode = args[:mode] if args.key?(:mode) @mutations = args[:mutations] if args.key?(:mutations) @transaction = args[:transaction] if args.key?(:transaction) end end # The response for Datastore.Commit. class CommitResponse include Google::Apis::Core::Hashable # The number of index entries updated during the commit, or zero if none were # updated. # Corresponds to the JSON property `indexUpdates` # @return [Fixnum] attr_accessor :index_updates # The result of performing the mutations. The i-th mutation result corresponds # to the i-th mutation in the request. # Corresponds to the JSON property `mutationResults` # @return [Array] attr_accessor :mutation_results def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @index_updates = args[:index_updates] if args.key?(:index_updates) @mutation_results = args[:mutation_results] if args.key?(:mutation_results) end end # A filter that merges multiple other filters using the given operator. class CompositeFilter include Google::Apis::Core::Hashable # The list of filters to combine. Must contain at least one filter. # Corresponds to the JSON property `filters` # @return [Array] attr_accessor :filters # The operator for combining multiple filters. # Corresponds to the JSON property `op` # @return [String] attr_accessor :op def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @filters = args[:filters] if args.key?(:filters) @op = args[:op] if args.key?(:op) end end # A generic empty message that you can re-use to avoid defining duplicated empty # messages in your APIs. A typical example is to use it as the request or the # response type of an API method. For instance: service Foo ` rpc Bar(google. # protobuf.Empty) returns (google.protobuf.Empty); ` The JSON representation for # `Empty` is empty JSON object ````. class Empty include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # A Datastore data object. An entity is limited to 1 megabyte when stored. That # _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this # message. class Entity include Google::Apis::Core::Hashable # A unique identifier for an entity. If a key's partition ID or any of its path # kinds or names are reserved/read-only, the key is reserved/read-only. A # reserved/read-only key is forbidden in certain documented contexts. # Corresponds to the JSON property `key` # @return [Google::Apis::DatastoreV1::Key] attr_accessor :key # The entity's properties. The map's keys are property names. A property name # matching regex `__.*__` is reserved. A reserved property name is forbidden in # certain documented contexts. The name must not contain more than 500 # characters. The name cannot be `""`. # Corresponds to the JSON property `properties` # @return [Hash] attr_accessor :properties def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @key = args[:key] if args.key?(:key) @properties = args[:properties] if args.key?(:properties) end end # The result of fetching an entity from Datastore. class EntityResult include Google::Apis::Core::Hashable # A cursor that points to the position after the result entity. Set only when # the `EntityResult` is part of a `QueryResultBatch` message. # Corresponds to the JSON property `cursor` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :cursor # A Datastore data object. An entity is limited to 1 megabyte when stored. That # _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this # message. # Corresponds to the JSON property `entity` # @return [Google::Apis::DatastoreV1::Entity] attr_accessor :entity # The version of the entity, a strictly positive number that monotonically # increases with changes to the entity. This field is set for `FULL` entity # results. For 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. # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cursor = args[:cursor] if args.key?(:cursor) @entity = args[:entity] if args.key?(:entity) @version = args[:version] if args.key?(:version) end end # A holder for any type of filter. class Filter include Google::Apis::Core::Hashable # A filter that merges multiple other filters using the given operator. # Corresponds to the JSON property `compositeFilter` # @return [Google::Apis::DatastoreV1::CompositeFilter] attr_accessor :composite_filter # A filter on a specific property. # Corresponds to the JSON property `propertyFilter` # @return [Google::Apis::DatastoreV1::PropertyFilter] attr_accessor :property_filter def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @composite_filter = args[:composite_filter] if args.key?(:composite_filter) @property_filter = args[:property_filter] if args.key?(:property_filter) end end # Metadata common to all Datastore Admin operations. class GoogleDatastoreAdminV1CommonMetadata include Google::Apis::Core::Hashable # The time the operation ended, either successfully or otherwise. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # The client-assigned labels which were provided when the operation was created. # May also include additional labels. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # The type of the operation. Can be used as a filter in ListOperationsRequest. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type # The time that work began on the operation. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # The current state of the Operation. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @end_time = args[:end_time] if args.key?(:end_time) @labels = args[:labels] if args.key?(:labels) @operation_type = args[:operation_type] if args.key?(:operation_type) @start_time = args[:start_time] if args.key?(:start_time) @state = args[:state] if args.key?(:state) end end # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as # described in the following examples). Example usage: Entire project: kinds=[], # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz # namespace: kinds=[], namespace_ids=['Baz'] class GoogleDatastoreAdminV1EntityFilter include Google::Apis::Core::Hashable # If empty, then this represents all kinds. # Corresponds to the JSON property `kinds` # @return [Array] attr_accessor :kinds # An empty list represents all namespaces. This is the preferred usage for # projects that don't use namespaces. An empty string element represents the # default namespace. This should be used if the project has data in non-default # namespaces, but doesn't want to include them. Each namespace in this list must # be unique. # Corresponds to the JSON property `namespaceIds` # @return [Array] attr_accessor :namespace_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kinds = args[:kinds] if args.key?(:kinds) @namespace_ids = args[:namespace_ids] if args.key?(:namespace_ids) end end # Metadata for ExportEntities operations. class GoogleDatastoreAdminV1ExportEntitiesMetadata include Google::Apis::Core::Hashable # Metadata common to all Datastore Admin operations. # Corresponds to the JSON property `common` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1CommonMetadata] attr_accessor :common # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as # described in the following examples). Example usage: Entire project: kinds=[], # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz # namespace: kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1EntityFilter] attr_accessor :entity_filter # Location for the export metadata and data files. This will be the same value # as the google.datastore.admin.v1.ExportEntitiesRequest.output_url_prefix field. # The final output location is provided in google.datastore.admin.v1. # ExportEntitiesResponse.output_url. # Corresponds to the JSON property `outputUrlPrefix` # @return [String] attr_accessor :output_url_prefix # Measures the progress of a particular metric. # Corresponds to the JSON property `progressBytes` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1Progress] attr_accessor :progress_bytes # Measures the progress of a particular metric. # Corresponds to the JSON property `progressEntities` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1Progress] attr_accessor :progress_entities def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @common = args[:common] if args.key?(:common) @entity_filter = args[:entity_filter] if args.key?(:entity_filter) @output_url_prefix = args[:output_url_prefix] if args.key?(:output_url_prefix) @progress_bytes = args[:progress_bytes] if args.key?(:progress_bytes) @progress_entities = args[:progress_entities] if args.key?(:progress_entities) end end # The request for google.datastore.admin.v1.DatastoreAdmin.ExportEntities. class GoogleDatastoreAdminV1ExportEntitiesRequest include Google::Apis::Core::Hashable # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as # described in the following examples). Example usage: Entire project: kinds=[], # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz # namespace: kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1EntityFilter] attr_accessor :entity_filter # Client-assigned labels. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # Required. Location for the export metadata and data files. The full resource # URL of the external storage location. Currently, only Google Cloud Storage is # supported. So output_url_prefix should be of the form: `gs://BUCKET_NAME[/ # NAMESPACE_PATH]`, where `BUCKET_NAME` is the name of the Cloud Storage bucket # and `NAMESPACE_PATH` is an optional Cloud Storage namespace path (this is not # a Cloud Datastore namespace). For more information about Cloud Storage # namespace paths, see [Object name considerations](https://cloud.google.com/ # storage/docs/naming#object-considerations). The resulting files will be nested # deeper than the specified URL prefix. The final output URL will be provided in # the google.datastore.admin.v1.ExportEntitiesResponse.output_url field. That # value should be used for subsequent ImportEntities operations. By nesting the # data files deeper, the same Cloud Storage bucket can be used in multiple # ExportEntities operations without conflict. # Corresponds to the JSON property `outputUrlPrefix` # @return [String] attr_accessor :output_url_prefix def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entity_filter = args[:entity_filter] if args.key?(:entity_filter) @labels = args[:labels] if args.key?(:labels) @output_url_prefix = args[:output_url_prefix] if args.key?(:output_url_prefix) end end # The response for google.datastore.admin.v1.DatastoreAdmin.ExportEntities. class GoogleDatastoreAdminV1ExportEntitiesResponse include Google::Apis::Core::Hashable # Location of the output metadata file. This can be used to begin an import into # Cloud Datastore (this project or another project). See google.datastore.admin. # v1.ImportEntitiesRequest.input_url. Only present if the operation completed # successfully. # Corresponds to the JSON property `outputUrl` # @return [String] attr_accessor :output_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @output_url = args[:output_url] if args.key?(:output_url) end end # Metadata for ImportEntities operations. class GoogleDatastoreAdminV1ImportEntitiesMetadata include Google::Apis::Core::Hashable # Metadata common to all Datastore Admin operations. # Corresponds to the JSON property `common` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1CommonMetadata] attr_accessor :common # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as # described in the following examples). Example usage: Entire project: kinds=[], # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz # namespace: kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1EntityFilter] attr_accessor :entity_filter # The location of the import metadata file. This will be the same value as the # google.datastore.admin.v1.ExportEntitiesResponse.output_url field. # Corresponds to the JSON property `inputUrl` # @return [String] attr_accessor :input_url # Measures the progress of a particular metric. # Corresponds to the JSON property `progressBytes` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1Progress] attr_accessor :progress_bytes # Measures the progress of a particular metric. # Corresponds to the JSON property `progressEntities` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1Progress] attr_accessor :progress_entities def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @common = args[:common] if args.key?(:common) @entity_filter = args[:entity_filter] if args.key?(:entity_filter) @input_url = args[:input_url] if args.key?(:input_url) @progress_bytes = args[:progress_bytes] if args.key?(:progress_bytes) @progress_entities = args[:progress_entities] if args.key?(:progress_entities) end end # The request for google.datastore.admin.v1.DatastoreAdmin.ImportEntities. class GoogleDatastoreAdminV1ImportEntitiesRequest include Google::Apis::Core::Hashable # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as # described in the following examples). Example usage: Entire project: kinds=[], # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz # namespace: kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1EntityFilter] attr_accessor :entity_filter # Required. The full resource URL of the external storage location. Currently, # only Google Cloud Storage is supported. So input_url should be of the form: ` # gs://BUCKET_NAME[/NAMESPACE_PATH]/OVERALL_EXPORT_METADATA_FILE`, where ` # BUCKET_NAME` is the name of the Cloud Storage bucket, `NAMESPACE_PATH` is an # optional Cloud Storage namespace path (this is not a Cloud Datastore namespace) # , and `OVERALL_EXPORT_METADATA_FILE` is the metadata file written by the # ExportEntities operation. For more information about Cloud Storage namespace # paths, see [Object name considerations](https://cloud.google.com/storage/docs/ # naming#object-considerations). For more information, see google.datastore. # admin.v1.ExportEntitiesResponse.output_url. # Corresponds to the JSON property `inputUrl` # @return [String] attr_accessor :input_url # Client-assigned labels. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @entity_filter = args[:entity_filter] if args.key?(:entity_filter) @input_url = args[:input_url] if args.key?(:input_url) @labels = args[:labels] if args.key?(:labels) end end # Datastore composite index definition. class GoogleDatastoreAdminV1Index include Google::Apis::Core::Hashable # Required. The index's ancestor mode. Must not be ANCESTOR_MODE_UNSPECIFIED. # Corresponds to the JSON property `ancestor` # @return [String] attr_accessor :ancestor # Output only. The resource ID of the index. # Corresponds to the JSON property `indexId` # @return [String] attr_accessor :index_id # Required. The entity kind to which this index applies. # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # Output only. Project ID. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id # Required. An ordered sequence of property names and their index attributes. # Corresponds to the JSON property `properties` # @return [Array] attr_accessor :properties # Output only. The state of the index. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @ancestor = args[:ancestor] if args.key?(:ancestor) @index_id = args[:index_id] if args.key?(:index_id) @kind = args[:kind] if args.key?(:kind) @project_id = args[:project_id] if args.key?(:project_id) @properties = args[:properties] if args.key?(:properties) @state = args[:state] if args.key?(:state) end end # Metadata for Index operations. class GoogleDatastoreAdminV1IndexOperationMetadata include Google::Apis::Core::Hashable # Metadata common to all Datastore Admin operations. # Corresponds to the JSON property `common` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1CommonMetadata] attr_accessor :common # The index resource ID that this operation is acting on. # Corresponds to the JSON property `indexId` # @return [String] attr_accessor :index_id # Measures the progress of a particular metric. # Corresponds to the JSON property `progressEntities` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1Progress] attr_accessor :progress_entities def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @common = args[:common] if args.key?(:common) @index_id = args[:index_id] if args.key?(:index_id) @progress_entities = args[:progress_entities] if args.key?(:progress_entities) end end # A property of an index. class GoogleDatastoreAdminV1IndexedProperty include Google::Apis::Core::Hashable # Required. The indexed property's direction. Must not be DIRECTION_UNSPECIFIED. # Corresponds to the JSON property `direction` # @return [String] attr_accessor :direction # Required. The property name to index. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @direction = args[:direction] if args.key?(:direction) @name = args[:name] if args.key?(:name) end end # The response for google.datastore.admin.v1.DatastoreAdmin.ListIndexes. class GoogleDatastoreAdminV1ListIndexesResponse include Google::Apis::Core::Hashable # The indexes. # Corresponds to the JSON property `indexes` # @return [Array] attr_accessor :indexes # The standard List next-page token. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @indexes = args[:indexes] if args.key?(:indexes) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) end end # Measures the progress of a particular metric. class GoogleDatastoreAdminV1Progress include Google::Apis::Core::Hashable # The amount of work that has been completed. Note that this may be greater than # work_estimated. # Corresponds to the JSON property `workCompleted` # @return [Fixnum] attr_accessor :work_completed # An estimate of how much work needs to be performed. May be zero if the work # estimate is unavailable. # Corresponds to the JSON property `workEstimated` # @return [Fixnum] attr_accessor :work_estimated def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @work_completed = args[:work_completed] if args.key?(:work_completed) @work_estimated = args[:work_estimated] if args.key?(:work_estimated) end end # Metadata common to all Datastore Admin operations. class GoogleDatastoreAdminV1beta1CommonMetadata include Google::Apis::Core::Hashable # The time the operation ended, either successfully or otherwise. # Corresponds to the JSON property `endTime` # @return [String] attr_accessor :end_time # The client-assigned labels which were provided when the operation was created. # May also include additional labels. # Corresponds to the JSON property `labels` # @return [Hash] attr_accessor :labels # The type of the operation. Can be used as a filter in ListOperationsRequest. # Corresponds to the JSON property `operationType` # @return [String] attr_accessor :operation_type # The time that work began on the operation. # Corresponds to the JSON property `startTime` # @return [String] attr_accessor :start_time # The current state of the Operation. # Corresponds to the JSON property `state` # @return [String] attr_accessor :state def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @end_time = args[:end_time] if args.key?(:end_time) @labels = args[:labels] if args.key?(:labels) @operation_type = args[:operation_type] if args.key?(:operation_type) @start_time = args[:start_time] if args.key?(:start_time) @state = args[:state] if args.key?(:state) end end # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as # described in the following examples). Example usage: Entire project: kinds=[], # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz # namespace: kinds=[], namespace_ids=['Baz'] class GoogleDatastoreAdminV1beta1EntityFilter include Google::Apis::Core::Hashable # If empty, then this represents all kinds. # Corresponds to the JSON property `kinds` # @return [Array] attr_accessor :kinds # An empty list represents all namespaces. This is the preferred usage for # projects that don't use namespaces. An empty string element represents the # default namespace. This should be used if the project has data in non-default # namespaces, but doesn't want to include them. Each namespace in this list must # be unique. # Corresponds to the JSON property `namespaceIds` # @return [Array] attr_accessor :namespace_ids def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @kinds = args[:kinds] if args.key?(:kinds) @namespace_ids = args[:namespace_ids] if args.key?(:namespace_ids) end end # Metadata for ExportEntities operations. class GoogleDatastoreAdminV1beta1ExportEntitiesMetadata include Google::Apis::Core::Hashable # Metadata common to all Datastore Admin operations. # Corresponds to the JSON property `common` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1beta1CommonMetadata] attr_accessor :common # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as # described in the following examples). Example usage: Entire project: kinds=[], # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz # namespace: kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1beta1EntityFilter] attr_accessor :entity_filter # Location for the export metadata and data files. This will be the same value # as the google.datastore.admin.v1beta1.ExportEntitiesRequest.output_url_prefix # field. The final output location is provided in google.datastore.admin.v1beta1. # ExportEntitiesResponse.output_url. # Corresponds to the JSON property `outputUrlPrefix` # @return [String] attr_accessor :output_url_prefix # Measures the progress of a particular metric. # Corresponds to the JSON property `progressBytes` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1beta1Progress] attr_accessor :progress_bytes # Measures the progress of a particular metric. # Corresponds to the JSON property `progressEntities` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1beta1Progress] attr_accessor :progress_entities def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @common = args[:common] if args.key?(:common) @entity_filter = args[:entity_filter] if args.key?(:entity_filter) @output_url_prefix = args[:output_url_prefix] if args.key?(:output_url_prefix) @progress_bytes = args[:progress_bytes] if args.key?(:progress_bytes) @progress_entities = args[:progress_entities] if args.key?(:progress_entities) end end # The response for google.datastore.admin.v1beta1.DatastoreAdmin.ExportEntities. class GoogleDatastoreAdminV1beta1ExportEntitiesResponse include Google::Apis::Core::Hashable # Location of the output metadata file. This can be used to begin an import into # Cloud Datastore (this project or another project). See google.datastore.admin. # v1beta1.ImportEntitiesRequest.input_url. Only present if the operation # completed successfully. # Corresponds to the JSON property `outputUrl` # @return [String] attr_accessor :output_url def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @output_url = args[:output_url] if args.key?(:output_url) end end # Metadata for ImportEntities operations. class GoogleDatastoreAdminV1beta1ImportEntitiesMetadata include Google::Apis::Core::Hashable # Metadata common to all Datastore Admin operations. # Corresponds to the JSON property `common` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1beta1CommonMetadata] attr_accessor :common # Identifies a subset of entities in a project. This is specified as # combinations of kinds and namespaces (either or both of which may be all, as # described in the following examples). Example usage: Entire project: kinds=[], # namespace_ids=[] Kinds Foo and Bar in all namespaces: kinds=['Foo', 'Bar'], # namespace_ids=[] Kinds Foo and Bar only in the default namespace: kinds=['Foo', # 'Bar'], namespace_ids=[''] Kinds Foo and Bar in both the default and Baz # namespaces: kinds=['Foo', 'Bar'], namespace_ids=['', 'Baz'] The entire Baz # namespace: kinds=[], namespace_ids=['Baz'] # Corresponds to the JSON property `entityFilter` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1beta1EntityFilter] attr_accessor :entity_filter # The location of the import metadata file. This will be the same value as the # google.datastore.admin.v1beta1.ExportEntitiesResponse.output_url field. # Corresponds to the JSON property `inputUrl` # @return [String] attr_accessor :input_url # Measures the progress of a particular metric. # Corresponds to the JSON property `progressBytes` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1beta1Progress] attr_accessor :progress_bytes # Measures the progress of a particular metric. # Corresponds to the JSON property `progressEntities` # @return [Google::Apis::DatastoreV1::GoogleDatastoreAdminV1beta1Progress] attr_accessor :progress_entities def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @common = args[:common] if args.key?(:common) @entity_filter = args[:entity_filter] if args.key?(:entity_filter) @input_url = args[:input_url] if args.key?(:input_url) @progress_bytes = args[:progress_bytes] if args.key?(:progress_bytes) @progress_entities = args[:progress_entities] if args.key?(:progress_entities) end end # Measures the progress of a particular metric. class GoogleDatastoreAdminV1beta1Progress include Google::Apis::Core::Hashable # The amount of work that has been completed. Note that this may be greater than # work_estimated. # Corresponds to the JSON property `workCompleted` # @return [Fixnum] attr_accessor :work_completed # An estimate of how much work needs to be performed. May be zero if the work # estimate is unavailable. # Corresponds to the JSON property `workEstimated` # @return [Fixnum] attr_accessor :work_estimated def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @work_completed = args[:work_completed] if args.key?(:work_completed) @work_estimated = args[:work_estimated] if args.key?(:work_estimated) end end # The response message for Operations.ListOperations. class GoogleLongrunningListOperationsResponse include Google::Apis::Core::Hashable # The standard List next-page token. # Corresponds to the JSON property `nextPageToken` # @return [String] attr_accessor :next_page_token # A list of operations that matches the specified filter in the request. # Corresponds to the JSON property `operations` # @return [Array] attr_accessor :operations def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @next_page_token = args[:next_page_token] if args.key?(:next_page_token) @operations = args[:operations] if args.key?(:operations) end end # This resource represents a long-running operation that is the result of a # network API call. class GoogleLongrunningOperation include Google::Apis::Core::Hashable # If the value is `false`, it means the operation is still in progress. If `true` # , the operation is completed, and either `error` or `response` is available. # Corresponds to the JSON property `done` # @return [Boolean] attr_accessor :done alias_method :done?, :done # The `Status` type defines a logical error model that is suitable for different # programming environments, including REST APIs and RPC APIs. It is used by [ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of # data: error code, error message, and error details. You can find out more # about this error model and how to work with it in the [API Design Guide](https: # //cloud.google.com/apis/design/errors). # Corresponds to the JSON property `error` # @return [Google::Apis::DatastoreV1::Status] attr_accessor :error # Service-specific metadata associated with the operation. It typically contains # progress information and common metadata such as create time. Some services # might not provide such metadata. Any method that returns a long-running # operation should document the metadata type, if any. # Corresponds to the JSON property `metadata` # @return [Hash] attr_accessor :metadata # The server-assigned name, which is only unique within the same service that # originally returns it. If you use the default HTTP mapping, the `name` should # be a resource name ending with `operations/`unique_id``. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name # The normal response of the operation in case of success. If the original # method returns no data on success, such as `Delete`, the response is `google. # protobuf.Empty`. If the original method is standard `Get`/`Create`/`Update`, # the response should be the resource. For other methods, the response should # have the type `XxxResponse`, where `Xxx` is the original method name. For # example, if the original method name is `TakeSnapshot()`, the inferred # response type is `TakeSnapshotResponse`. # Corresponds to the JSON property `response` # @return [Hash] attr_accessor :response def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @done = args[:done] if args.key?(:done) @error = args[:error] if args.key?(:error) @metadata = args[:metadata] if args.key?(:metadata) @name = args[:name] if args.key?(:name) @response = args[:response] if args.key?(:response) end end # A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). class GqlQuery include Google::Apis::Core::Hashable # 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. # Corresponds to the JSON property `allowLiterals` # @return [Boolean] attr_accessor :allow_literals alias_method :allow_literals?, :allow_literals # 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_$*`, must not match regex `__.*__`, and must not be `""`. # Corresponds to the JSON property `namedBindings` # @return [Hash] attr_accessor :named_bindings # 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. # Corresponds to the JSON property `positionalBindings` # @return [Array] attr_accessor :positional_bindings # A string of the format described [here](https://cloud.google.com/datastore/ # docs/apis/gql/gql_reference). # Corresponds to the JSON property `queryString` # @return [String] attr_accessor :query_string def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @allow_literals = args[:allow_literals] if args.key?(:allow_literals) @named_bindings = args[:named_bindings] if args.key?(:named_bindings) @positional_bindings = args[:positional_bindings] if args.key?(:positional_bindings) @query_string = args[:query_string] if args.key?(:query_string) end end # A binding parameter for a GQL query. class GqlQueryParameter include Google::Apis::Core::Hashable # A query cursor. Query cursors are returned in query result batches. # Corresponds to the JSON property `cursor` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :cursor # A message that can hold any of the supported value types and associated # metadata. # Corresponds to the JSON property `value` # @return [Google::Apis::DatastoreV1::Value] attr_accessor :value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @cursor = args[:cursor] if args.key?(:cursor) @value = args[:value] if args.key?(:value) end end # A unique identifier for an entity. If a key's partition ID or any of its path # kinds or names are reserved/read-only, the key is reserved/read-only. A # reserved/read-only key is forbidden in certain documented contexts. class Key include Google::Apis::Core::Hashable # A partition ID identifies a grouping of entities. The grouping is always by # project and namespace, however the namespace ID may be empty. A partition ID # contains several dimensions: project ID and namespace ID. Partition dimensions: # - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match # regex `[A-Za-z\d\.\-_]`1,100`` If the value of any dimension matches regex `__. # *__`, the partition is reserved/read-only. A reserved/read-only partition ID # is forbidden in certain documented contexts. Foreign partition IDs (in which # the project ID does not match the context project ID ) are discouraged. Reads # and writes of foreign partition IDs may fail if the project is not in an # active state. # Corresponds to the JSON property `partitionId` # @return [Google::Apis::DatastoreV1::PartitionId] attr_accessor :partition_id # The entity path. An entity path consists of one or more elements composed of a # kind and a string or numerical identifier, which identify entities. The first # element identifies a _root entity_, the second element identifies a _child_ of # the root entity, the third element identifies a child of the second entity, # and so forth. The entities identified by all prefixes of the path are called # the element's _ancestors_. An entity path is always fully complete: *all* of # the entity's ancestors are required to be in the path along with the entity # identifier itself. The only exception is that in some documented cases, the # identifier in the last path element (for the entity) itself may be omitted. # For example, the last path element of the key of `Mutation.insert` may have no # identifier. A path can never be empty, and a path can have at most 100 # elements. # Corresponds to the JSON property `path` # @return [Array] attr_accessor :path def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @partition_id = args[:partition_id] if args.key?(:partition_id) @path = args[:path] if args.key?(:path) end end # A representation of a kind. class KindExpression include Google::Apis::Core::Hashable # The name of the kind. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) end end # An object that represents a latitude/longitude pair. This is expressed as a # pair of doubles to represent degrees latitude and degrees longitude. Unless # specified otherwise, this must conform to the WGS84 standard. Values must be # within normalized ranges. class LatLng include Google::Apis::Core::Hashable # The latitude in degrees. It must be in the range [-90.0, +90.0]. # Corresponds to the JSON property `latitude` # @return [Float] attr_accessor :latitude # The longitude in degrees. It must be in the range [-180.0, +180.0]. # Corresponds to the JSON property `longitude` # @return [Float] attr_accessor :longitude def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @latitude = args[:latitude] if args.key?(:latitude) @longitude = args[:longitude] if args.key?(:longitude) end end # The request for Datastore.Lookup. class LookupRequest include Google::Apis::Core::Hashable # Required. Keys of entities to look up. # Corresponds to the JSON property `keys` # @return [Array] attr_accessor :keys # The options shared by read requests. # Corresponds to the JSON property `readOptions` # @return [Google::Apis::DatastoreV1::ReadOptions] attr_accessor :read_options def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @keys = args[:keys] if args.key?(:keys) @read_options = args[:read_options] if args.key?(:read_options) end end # The response for Datastore.Lookup. class LookupResponse include Google::Apis::Core::Hashable # A list of keys that were not looked up due to resource constraints. The order # of results in this field is undefined and has no relation to the order of the # keys in the input. # Corresponds to the JSON property `deferred` # @return [Array] attr_accessor :deferred # Entities found as `ResultType.FULL` entities. The order of results in this # field is undefined and has no relation to the order of the keys in the input. # Corresponds to the JSON property `found` # @return [Array] attr_accessor :found # Entities not found as `ResultType.KEY_ONLY` entities. The order of results in # this field is undefined and has no relation to the order of the keys in the # input. # Corresponds to the JSON property `missing` # @return [Array] attr_accessor :missing def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @deferred = args[:deferred] if args.key?(:deferred) @found = args[:found] if args.key?(:found) @missing = args[:missing] if args.key?(:missing) end end # A mutation to apply to an entity. class Mutation include Google::Apis::Core::Hashable # The version of the entity that this mutation is being applied to. If this does # not match the current version on the server, the mutation conflicts. # Corresponds to the JSON property `baseVersion` # @return [Fixnum] attr_accessor :base_version # A unique identifier for an entity. If a key's partition ID or any of its path # kinds or names are reserved/read-only, the key is reserved/read-only. A # reserved/read-only key is forbidden in certain documented contexts. # Corresponds to the JSON property `delete` # @return [Google::Apis::DatastoreV1::Key] attr_accessor :delete # A Datastore data object. An entity is limited to 1 megabyte when stored. That # _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this # message. # Corresponds to the JSON property `insert` # @return [Google::Apis::DatastoreV1::Entity] attr_accessor :insert # A Datastore data object. An entity is limited to 1 megabyte when stored. That # _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this # message. # Corresponds to the JSON property `update` # @return [Google::Apis::DatastoreV1::Entity] attr_accessor :update # A Datastore data object. An entity is limited to 1 megabyte when stored. That # _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this # message. # Corresponds to the JSON property `upsert` # @return [Google::Apis::DatastoreV1::Entity] attr_accessor :upsert def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @base_version = args[:base_version] if args.key?(:base_version) @delete = args[:delete] if args.key?(:delete) @insert = args[:insert] if args.key?(:insert) @update = args[:update] if args.key?(:update) @upsert = args[:upsert] if args.key?(:upsert) end end # The result of applying a mutation. class MutationResult include Google::Apis::Core::Hashable # Whether a conflict was detected for this mutation. Always false when a # conflict detection strategy field is not set in the mutation. # Corresponds to the JSON property `conflictDetected` # @return [Boolean] attr_accessor :conflict_detected alias_method :conflict_detected?, :conflict_detected # A unique identifier for an entity. If a key's partition ID or any of its path # kinds or names are reserved/read-only, the key is reserved/read-only. A # reserved/read-only key is forbidden in certain documented contexts. # Corresponds to the JSON property `key` # @return [Google::Apis::DatastoreV1::Key] attr_accessor :key # The version of the entity on the server after processing the mutation. If the # mutation doesn't change anything on the server, then the version will be the # version of the current entity or, if no entity is present, a version that is # strictly greater than the version of any previous entity and less than the # version of any possible future entity. # Corresponds to the JSON property `version` # @return [Fixnum] attr_accessor :version def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @conflict_detected = args[:conflict_detected] if args.key?(:conflict_detected) @key = args[:key] if args.key?(:key) @version = args[:version] if args.key?(:version) end end # A partition ID identifies a grouping of entities. The grouping is always by # project and namespace, however the namespace ID may be empty. A partition ID # contains several dimensions: project ID and namespace ID. Partition dimensions: # - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match # regex `[A-Za-z\d\.\-_]`1,100`` If the value of any dimension matches regex `__. # *__`, the partition is reserved/read-only. A reserved/read-only partition ID # is forbidden in certain documented contexts. Foreign partition IDs (in which # the project ID does not match the context project ID ) are discouraged. Reads # and writes of foreign partition IDs may fail if the project is not in an # active state. class PartitionId include Google::Apis::Core::Hashable # If not empty, the ID of the namespace to which the entities belong. # Corresponds to the JSON property `namespaceId` # @return [String] attr_accessor :namespace_id # The ID of the project to which the entities belong. # Corresponds to the JSON property `projectId` # @return [String] attr_accessor :project_id def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @namespace_id = args[:namespace_id] if args.key?(:namespace_id) @project_id = args[:project_id] if args.key?(:project_id) end end # A (kind, ID/name) pair used to construct a key path. If either name or ID is # set, the element is complete. If neither is set, the element is incomplete. class PathElement include Google::Apis::Core::Hashable # The auto-allocated ID of the entity. Never equal to zero. Values less than # zero are discouraged and may not be supported in the future. # Corresponds to the JSON property `id` # @return [Fixnum] attr_accessor :id # The kind of the entity. A kind matching regex `__.*__` is reserved/read-only. # A kind must not contain more than 1500 bytes when UTF-8 encoded. Cannot be `""` # . # Corresponds to the JSON property `kind` # @return [String] attr_accessor :kind # The name of the entity. A name matching regex `__.*__` is reserved/read-only. # A name must not be more than 1500 bytes when UTF-8 encoded. Cannot be `""`. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @id = args[:id] if args.key?(:id) @kind = args[:kind] if args.key?(:kind) @name = args[:name] if args.key?(:name) end end # A representation of a property in a projection. class Projection include Google::Apis::Core::Hashable # A reference to a property relative to the kind expressions. # Corresponds to the JSON property `property` # @return [Google::Apis::DatastoreV1::PropertyReference] attr_accessor :property def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @property = args[:property] if args.key?(:property) end end # A filter on a specific property. class PropertyFilter include Google::Apis::Core::Hashable # The operator to filter by. # Corresponds to the JSON property `op` # @return [String] attr_accessor :op # A reference to a property relative to the kind expressions. # Corresponds to the JSON property `property` # @return [Google::Apis::DatastoreV1::PropertyReference] attr_accessor :property # A message that can hold any of the supported value types and associated # metadata. # Corresponds to the JSON property `value` # @return [Google::Apis::DatastoreV1::Value] attr_accessor :value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @op = args[:op] if args.key?(:op) @property = args[:property] if args.key?(:property) @value = args[:value] if args.key?(:value) end end # The desired order for a specific property. class PropertyOrder include Google::Apis::Core::Hashable # The direction to order by. Defaults to `ASCENDING`. # Corresponds to the JSON property `direction` # @return [String] attr_accessor :direction # A reference to a property relative to the kind expressions. # Corresponds to the JSON property `property` # @return [Google::Apis::DatastoreV1::PropertyReference] attr_accessor :property def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @direction = args[:direction] if args.key?(:direction) @property = args[:property] if args.key?(:property) end end # A reference to a property relative to the kind expressions. class PropertyReference include Google::Apis::Core::Hashable # The name of the property. If name includes "."s, it may be interpreted as a # property name path. # Corresponds to the JSON property `name` # @return [String] attr_accessor :name def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @name = args[:name] if args.key?(:name) end end # A query for entities. class Query include Google::Apis::Core::Hashable # 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). # Corresponds to the JSON property `distinctOn` # @return [Array] attr_accessor :distinct_on # 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). # Corresponds to the JSON property `endCursor` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :end_cursor # A holder for any type of filter. # Corresponds to the JSON property `filter` # @return [Google::Apis::DatastoreV1::Filter] attr_accessor :filter # The kinds to query (if empty, returns entities of all kinds). Currently at # most 1 kind may be specified. # Corresponds to the JSON property `kind` # @return [Array] attr_accessor :kind # The maximum number of results to return. Applies after all other constraints. # Optional. Unspecified is interpreted as no limit. Must be >= 0 if specified. # Corresponds to the JSON property `limit` # @return [Fixnum] attr_accessor :limit # The number of results to skip. Applies before limit, but after all other # constraints. Optional. Must be >= 0 if specified. # Corresponds to the JSON property `offset` # @return [Fixnum] attr_accessor :offset # The order to apply to the query results (if empty, order is unspecified). # Corresponds to the JSON property `order` # @return [Array] attr_accessor :order # The projection to return. Defaults to returning all properties. # Corresponds to the JSON property `projection` # @return [Array] attr_accessor :projection # 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). # Corresponds to the JSON property `startCursor` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :start_cursor def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @distinct_on = args[:distinct_on] if args.key?(:distinct_on) @end_cursor = args[:end_cursor] if args.key?(:end_cursor) @filter = args[:filter] if args.key?(:filter) @kind = args[:kind] if args.key?(:kind) @limit = args[:limit] if args.key?(:limit) @offset = args[:offset] if args.key?(:offset) @order = args[:order] if args.key?(:order) @projection = args[:projection] if args.key?(:projection) @start_cursor = args[:start_cursor] if args.key?(:start_cursor) end end # A batch of results produced by a query. class QueryResultBatch include Google::Apis::Core::Hashable # A cursor that points to the position after the last result in the batch. # Corresponds to the JSON property `endCursor` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :end_cursor # The result type for every entity in `entity_results`. # Corresponds to the JSON property `entityResultType` # @return [String] attr_accessor :entity_result_type # The results for this batch. # Corresponds to the JSON property `entityResults` # @return [Array] attr_accessor :entity_results # The state of the query after the current batch. # Corresponds to the JSON property `moreResults` # @return [String] attr_accessor :more_results # A cursor that points to the position after the last skipped result. Will be # set when `skipped_results` != 0. # Corresponds to the JSON property `skippedCursor` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :skipped_cursor # The number of results skipped, typically because of an offset. # Corresponds to the JSON property `skippedResults` # @return [Fixnum] attr_accessor :skipped_results # 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. # Corresponds to the JSON property `snapshotVersion` # @return [Fixnum] attr_accessor :snapshot_version def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @end_cursor = args[:end_cursor] if args.key?(:end_cursor) @entity_result_type = args[:entity_result_type] if args.key?(:entity_result_type) @entity_results = args[:entity_results] if args.key?(:entity_results) @more_results = args[:more_results] if args.key?(:more_results) @skipped_cursor = args[:skipped_cursor] if args.key?(:skipped_cursor) @skipped_results = args[:skipped_results] if args.key?(:skipped_results) @snapshot_version = args[:snapshot_version] if args.key?(:snapshot_version) end end # Options specific to read-only transactions. class ReadOnly include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # The options shared by read requests. class ReadOptions include Google::Apis::Core::Hashable # The non-transactional read consistency to use. Cannot be set to `STRONG` for # global queries. # Corresponds to the JSON property `readConsistency` # @return [String] attr_accessor :read_consistency # The identifier of the transaction in which to read. A transaction identifier # is returned by a call to Datastore.BeginTransaction. # Corresponds to the JSON property `transaction` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :transaction def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @read_consistency = args[:read_consistency] if args.key?(:read_consistency) @transaction = args[:transaction] if args.key?(:transaction) end end # Options specific to read / write transactions. class ReadWrite include Google::Apis::Core::Hashable # The transaction identifier of the transaction being retried. # Corresponds to the JSON property `previousTransaction` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :previous_transaction def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @previous_transaction = args[:previous_transaction] if args.key?(:previous_transaction) end end # The request for Datastore.ReserveIds. class ReserveIdsRequest include Google::Apis::Core::Hashable # If not empty, the ID of the database against which to make the request. # Corresponds to the JSON property `databaseId` # @return [String] attr_accessor :database_id # Required. A list of keys with complete key paths whose numeric IDs should not # be auto-allocated. # Corresponds to the JSON property `keys` # @return [Array] attr_accessor :keys def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @database_id = args[:database_id] if args.key?(:database_id) @keys = args[:keys] if args.key?(:keys) end end # The response for Datastore.ReserveIds. class ReserveIdsResponse include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # The request for Datastore.Rollback. class RollbackRequest include Google::Apis::Core::Hashable # Required. The transaction identifier, returned by a call to Datastore. # BeginTransaction. # Corresponds to the JSON property `transaction` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :transaction def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @transaction = args[:transaction] if args.key?(:transaction) end end # The response for Datastore.Rollback. (an empty message). class RollbackResponse include Google::Apis::Core::Hashable def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) end end # The request for Datastore.RunQuery. class RunQueryRequest include Google::Apis::Core::Hashable # A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference). # Corresponds to the JSON property `gqlQuery` # @return [Google::Apis::DatastoreV1::GqlQuery] attr_accessor :gql_query # A partition ID identifies a grouping of entities. The grouping is always by # project and namespace, however the namespace ID may be empty. A partition ID # contains several dimensions: project ID and namespace ID. Partition dimensions: # - May be `""`. - Must be valid UTF-8 bytes. - Must have values that match # regex `[A-Za-z\d\.\-_]`1,100`` If the value of any dimension matches regex `__. # *__`, the partition is reserved/read-only. A reserved/read-only partition ID # is forbidden in certain documented contexts. Foreign partition IDs (in which # the project ID does not match the context project ID ) are discouraged. Reads # and writes of foreign partition IDs may fail if the project is not in an # active state. # Corresponds to the JSON property `partitionId` # @return [Google::Apis::DatastoreV1::PartitionId] attr_accessor :partition_id # A query for entities. # Corresponds to the JSON property `query` # @return [Google::Apis::DatastoreV1::Query] attr_accessor :query # The options shared by read requests. # Corresponds to the JSON property `readOptions` # @return [Google::Apis::DatastoreV1::ReadOptions] attr_accessor :read_options def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @gql_query = args[:gql_query] if args.key?(:gql_query) @partition_id = args[:partition_id] if args.key?(:partition_id) @query = args[:query] if args.key?(:query) @read_options = args[:read_options] if args.key?(:read_options) end end # The response for Datastore.RunQuery. class RunQueryResponse include Google::Apis::Core::Hashable # A batch of results produced by a query. # Corresponds to the JSON property `batch` # @return [Google::Apis::DatastoreV1::QueryResultBatch] attr_accessor :batch # A query for entities. # Corresponds to the JSON property `query` # @return [Google::Apis::DatastoreV1::Query] attr_accessor :query def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @batch = args[:batch] if args.key?(:batch) @query = args[:query] if args.key?(:query) end end # The `Status` type defines a logical error model that is suitable for different # programming environments, including REST APIs and RPC APIs. It is used by [ # gRPC](https://github.com/grpc). Each `Status` message contains three pieces of # data: error code, error message, and error details. You can find out more # about this error model and how to work with it in the [API Design Guide](https: # //cloud.google.com/apis/design/errors). class Status include Google::Apis::Core::Hashable # The status code, which should be an enum value of google.rpc.Code. # Corresponds to the JSON property `code` # @return [Fixnum] attr_accessor :code # A list of messages that carry the error details. There is a common set of # message types for APIs to use. # Corresponds to the JSON property `details` # @return [Array>] attr_accessor :details # A developer-facing error message, which should be in English. Any user-facing # error message should be localized and sent in the google.rpc.Status.details # field, or localized by the client. # Corresponds to the JSON property `message` # @return [String] attr_accessor :message def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @code = args[:code] if args.key?(:code) @details = args[:details] if args.key?(:details) @message = args[:message] if args.key?(:message) end end # Options for beginning a new transaction. Transactions can be created # explicitly with calls to Datastore.BeginTransaction or implicitly by setting # ReadOptions.new_transaction in read requests. class TransactionOptions include Google::Apis::Core::Hashable # Options specific to read-only transactions. # Corresponds to the JSON property `readOnly` # @return [Google::Apis::DatastoreV1::ReadOnly] attr_accessor :read_only # Options specific to read / write transactions. # Corresponds to the JSON property `readWrite` # @return [Google::Apis::DatastoreV1::ReadWrite] attr_accessor :read_write def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @read_only = args[:read_only] if args.key?(:read_only) @read_write = args[:read_write] if args.key?(:read_write) end end # A message that can hold any of the supported value types and associated # metadata. class Value include Google::Apis::Core::Hashable # An array value. # Corresponds to the JSON property `arrayValue` # @return [Google::Apis::DatastoreV1::ArrayValue] attr_accessor :array_value # A blob value. May have at most 1,000,000 bytes. When `exclude_from_indexes` is # false, may have at most 1500 bytes. In JSON requests, must be base64-encoded. # Corresponds to the JSON property `blobValue` # NOTE: Values are automatically base64 encoded/decoded in the client library. # @return [String] attr_accessor :blob_value # A boolean value. # Corresponds to the JSON property `booleanValue` # @return [Boolean] attr_accessor :boolean_value alias_method :boolean_value?, :boolean_value # A double value. # Corresponds to the JSON property `doubleValue` # @return [Float] attr_accessor :double_value # A Datastore data object. An entity is limited to 1 megabyte when stored. That # _roughly_ corresponds to a limit of 1 megabyte for the serialized form of this # message. # Corresponds to the JSON property `entityValue` # @return [Google::Apis::DatastoreV1::Entity] attr_accessor :entity_value # If the value should be excluded from all indexes including those defined # explicitly. # Corresponds to the JSON property `excludeFromIndexes` # @return [Boolean] attr_accessor :exclude_from_indexes alias_method :exclude_from_indexes?, :exclude_from_indexes # An object that represents a latitude/longitude pair. This is expressed as a # pair of doubles to represent degrees latitude and degrees longitude. Unless # specified otherwise, this must conform to the WGS84 standard. Values must be # within normalized ranges. # Corresponds to the JSON property `geoPointValue` # @return [Google::Apis::DatastoreV1::LatLng] attr_accessor :geo_point_value # An integer value. # Corresponds to the JSON property `integerValue` # @return [Fixnum] attr_accessor :integer_value # A unique identifier for an entity. If a key's partition ID or any of its path # kinds or names are reserved/read-only, the key is reserved/read-only. A # reserved/read-only key is forbidden in certain documented contexts. # Corresponds to the JSON property `keyValue` # @return [Google::Apis::DatastoreV1::Key] attr_accessor :key_value # The `meaning` field should only be populated for backwards compatibility. # Corresponds to the JSON property `meaning` # @return [Fixnum] attr_accessor :meaning # A null value. # Corresponds to the JSON property `nullValue` # @return [String] attr_accessor :null_value # A UTF-8 encoded string value. When `exclude_from_indexes` is false (it is # indexed) , may have at most 1500 bytes. Otherwise, may be set to at most 1,000, # 000 bytes. # Corresponds to the JSON property `stringValue` # @return [String] attr_accessor :string_value # A timestamp value. When stored in the Datastore, precise only to microseconds; # any additional precision is rounded down. # Corresponds to the JSON property `timestampValue` # @return [String] attr_accessor :timestamp_value def initialize(**args) update!(**args) end # Update properties of this object def update!(**args) @array_value = args[:array_value] if args.key?(:array_value) @blob_value = args[:blob_value] if args.key?(:blob_value) @boolean_value = args[:boolean_value] if args.key?(:boolean_value) @double_value = args[:double_value] if args.key?(:double_value) @entity_value = args[:entity_value] if args.key?(:entity_value) @exclude_from_indexes = args[:exclude_from_indexes] if args.key?(:exclude_from_indexes) @geo_point_value = args[:geo_point_value] if args.key?(:geo_point_value) @integer_value = args[:integer_value] if args.key?(:integer_value) @key_value = args[:key_value] if args.key?(:key_value) @meaning = args[:meaning] if args.key?(:meaning) @null_value = args[:null_value] if args.key?(:null_value) @string_value = args[:string_value] if args.key?(:string_value) @timestamp_value = args[:timestamp_value] if args.key?(:timestamp_value) end end end end end