generated/google/apis/datastore_v1beta3/classes.rb in google-api-client-0.43.0 vs generated/google/apis/datastore_v1beta3/classes.rb in google-api-client-0.44.0
- old
+ new
@@ -44,12 +44,12 @@
# 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.
+ # 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<Google::Apis::DatastoreV1beta3::Key>]
attr_accessor :keys
def initialize(**args)
@@ -64,13 +64,12 @@
# 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'.
+ # 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<Google::Apis::DatastoreV1beta3::Value>]
attr_accessor :values
def initialize(**args)
@@ -85,13 +84,12 @@
# 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
+ # 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::DatastoreV1beta3::TransactionOptions]
attr_accessor :transaction_options
@@ -132,27 +130,22 @@
# 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.
+ # 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<Google::Apis::DatastoreV1beta3::Mutation>]
attr_accessor :mutations
- # The identifier of the transaction associated with the commit. A
- # transaction identifier is returned by a call to
- # Datastore.BeginTransaction.
+ # 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
@@ -176,12 +169,12 @@
# 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.
+ # 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<Google::Apis::DatastoreV1beta3::MutationResult>]
attr_accessor :mutation_results
def initialize(**args)
@@ -197,12 +190,11 @@
# 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.
+ # The list of filters to combine. Must contain at least one filter.
# Corresponds to the JSON property `filters`
# @return [Array<Google::Apis::DatastoreV1beta3::Filter>]
attr_accessor :filters
# The operator for combining multiple filters.
@@ -219,31 +211,27 @@
@filters = args[:filters] if args.key?(:filters)
@op = args[:op] if args.key?(:op)
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
+ # 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.
+ # 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::DatastoreV1beta3::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 `""`.
+ # 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<String,Google::Apis::DatastoreV1beta3::Value>]
attr_accessor :properties
def initialize(**args)
@@ -259,32 +247,29 @@
# 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.
+ # 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
+ # 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::DatastoreV1beta3::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.
+ # 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)
@@ -331,18 +316,17 @@
# 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.
+ # 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<String,String>]
attr_accessor :labels
- # The type of the operation. Can be used as a filter in
- # ListOperationsRequest.
+ # 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.
@@ -369,36 +353,29 @@
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']
+ # 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<String>]
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.
+ # 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<String>]
attr_accessor :namespace_ids
def initialize(**args)
@@ -421,31 +398,24 @@
# @return [Google::Apis::DatastoreV1beta3::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']
+ # 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::DatastoreV1beta3::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.
+ # 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.
@@ -470,19 +440,18 @@
@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.v1.DatastoreAdmin.ExportEntities.
+ # 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.
+ # 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)
@@ -504,28 +473,22 @@
# @return [Google::Apis::DatastoreV1beta3::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']
+ # 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::DatastoreV1beta3::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.
+ # 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.
@@ -585,18 +548,18 @@
# 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.
+ # 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.
+ # 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)
@@ -617,18 +580,17 @@
# 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.
+ # 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<String,String>]
attr_accessor :labels
- # The type of the operation. Can be used as a filter in
- # ListOperationsRequest.
+ # 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.
@@ -655,36 +617,29 @@
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']
+ # 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<String>]
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.
+ # 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<String>]
attr_accessor :namespace_ids
def initialize(**args)
@@ -707,31 +662,24 @@
# @return [Google::Apis::DatastoreV1beta3::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']
+ # 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::DatastoreV1beta3::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.
+ # 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.
@@ -756,19 +704,18 @@
@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.
+ # 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.
+ # 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)
@@ -790,29 +737,22 @@
# @return [Google::Apis::DatastoreV1beta3::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']
+ # 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::DatastoreV1beta3::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.
+ # 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.
@@ -841,18 +781,18 @@
# 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.
+ # 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.
+ # 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)
@@ -864,42 +804,39 @@
@work_completed = args[:work_completed] if args.key?(:work_completed)
@work_estimated = args[:work_estimated] if args.key?(:work_estimated)
end
end
- # A [GQL
- # query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
+ # 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.
+ # 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 `""`.
+ # 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<String,Google::Apis::DatastoreV1beta3::GqlQueryParameter>]
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.
+ # 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<Google::Apis::DatastoreV1beta3::GqlQueryParameter>]
attr_accessor :positional_bindings
- # A string of the format described
- # [here](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
+ # 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)
@@ -917,12 +854,11 @@
# 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.
+ # 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
@@ -941,51 +877,42 @@
@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.
+ # 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
+ # 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::DatastoreV1beta3::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.
+ # 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<Google::Apis::DatastoreV1beta3::PathElement>]
attr_accessor :path
def initialize(**args)
@@ -1018,13 +945,12 @@
end
end
# An object representing a latitude/longitude pair. This is expressed as a pair
# of doubles representing degrees latitude and degrees longitude. Unless
- # specified otherwise, this must conform to the
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
- # standard</a>. Values must be within normalized ranges.
+ # 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`
@@ -1074,27 +1000,26 @@
# 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.
+ # 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<Google::Apis::DatastoreV1beta3::Key>]
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.
+ # field is undefined and has no relation to the order of the keys in the input.
# Corresponds to the JSON property `found`
# @return [Array<Google::Apis::DatastoreV1beta3::EntityResult>]
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.
+ # 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<Google::Apis::DatastoreV1beta3::EntityResult>]
attr_accessor :missing
def initialize(**args)
@@ -1111,43 +1036,39 @@
# 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.
+ # 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.
+ # 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::DatastoreV1beta3::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
+ # 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::DatastoreV1beta3::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
+ # 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::DatastoreV1beta3::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
+ # 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::DatastoreV1beta3::Entity]
attr_accessor :upsert
@@ -1174,23 +1095,22 @@
# 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.
+ # 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::DatastoreV1beta3::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.
+ # 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)
@@ -1203,25 +1123,19 @@
@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
+ # 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.
@@ -1243,35 +1157,30 @@
@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.
+ # 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.
+ # 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 `""`.
+ # 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 `""`.
+ # 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)
@@ -1364,12 +1273,12 @@
# 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.
+ # 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)
@@ -1385,41 +1294,37 @@
# 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).
+ # 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<Google::Apis::DatastoreV1beta3::PropertyReference>]
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).
+ # 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::DatastoreV1beta3::Filter]
attr_accessor :filter
- # The kinds to query (if empty, returns entities of all kinds).
- # Currently at most 1 kind may be specified.
+ # 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<Google::Apis::DatastoreV1beta3::KindExpression>]
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.
+ # 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
@@ -1436,15 +1341,13 @@
# The projection to return. Defaults to returning all properties.
# Corresponds to the JSON property `projection`
# @return [Array<Google::Apis::DatastoreV1beta3::Projection>]
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).
+ # 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
@@ -1489,30 +1392,29 @@
# 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.
+ # 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.
+ # 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)
@@ -1546,19 +1448,18 @@
# 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.
+ # 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.
+ # 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
@@ -1601,12 +1502,11 @@
# 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.
+ # be auto-allocated.
# Corresponds to the JSON property `keys`
# @return [Array<Google::Apis::DatastoreV1beta3::Key>]
attr_accessor :keys
def initialize(**args)
@@ -1635,12 +1535,12 @@
# The request for Datastore.Rollback.
class RollbackRequest
include Google::Apis::Core::Hashable
- # Required. The transaction identifier, returned by a call to
- # Datastore.BeginTransaction.
+ # 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
@@ -1652,12 +1552,11 @@
def update!(**args)
@transaction = args[:transaction] if args.key?(:transaction)
end
end
- # The response for Datastore.Rollback.
- # (an empty message).
+ # The response for Datastore.Rollback. (an empty message).
class RollbackResponse
include Google::Apis::Core::Hashable
def initialize(**args)
update!(**args)
@@ -1670,31 +1569,24 @@
# 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).
+ # A [GQL query](https://cloud.google.com/datastore/docs/apis/gql/gql_reference).
# Corresponds to the JSON property `gqlQuery`
# @return [Google::Apis::DatastoreV1beta3::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
+ # 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::DatastoreV1beta3::PartitionId]
attr_accessor :partition_id
@@ -1744,13 +1636,12 @@
@batch = args[:batch] if args.key?(:batch)
@query = args[:query] if args.key?(:query)
end
end
- # Options for beginning a new transaction.
- # Transactions can be created explicitly with calls to
- # Datastore.BeginTransaction or implicitly by setting
+ # 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.
@@ -1782,14 +1673,12 @@
# An array value.
# Corresponds to the JSON property `arrayValue`
# @return [Google::Apis::DatastoreV1beta3::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.
+ # 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
@@ -1802,13 +1691,12 @@
# 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
+ # 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::DatastoreV1beta3::Entity]
attr_accessor :entity_value
@@ -1819,26 +1707,24 @@
attr_accessor :exclude_from_indexes
alias_method :exclude_from_indexes?, :exclude_from_indexes
# An object representing a latitude/longitude pair. This is expressed as a pair
# of doubles representing degrees latitude and degrees longitude. Unless
- # specified otherwise, this must conform to the
- # <a href="http://www.unoosa.org/pdf/icg/2012/template/WGS_84.pdf">WGS84
- # standard</a>. Values must be within normalized ranges.
+ # specified otherwise, this must conform to the WGS84 standard. Values must be
+ # within normalized ranges.
# Corresponds to the JSON property `geoPointValue`
# @return [Google::Apis::DatastoreV1beta3::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.
+ # 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::DatastoreV1beta3::Key]
attr_accessor :key_value
# The `meaning` field should only be populated for backwards compatibility.
@@ -1849,19 +1735,17 @@
# 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.
+ # 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;
+ # 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