Package Methods (2.21.0)

Summary of entries of Methods for datastore.

google.cloud.datastore.helpers.entity_from_protobuf

  entity_from_protobuf 
 ( 
 pb 
 ) 
 

Factory method for creating an entity based on a protobuf.

See more: google.cloud.datastore.helpers.entity_from_protobuf

google.cloud.datastore.helpers.entity_to_protobuf

  entity_to_protobuf 
 ( 
 entity 
 ) 
 

Converts an entity into a protobuf.

See more: google.cloud.datastore.helpers.entity_to_protobuf

google.cloud.datastore.helpers.get_read_options

  get_read_options 
 ( 
 eventual 
 , 
 transaction_id 
 , 
 read_time 
 = 
 None 
 , 
 new_transaction_options 
 = 
 None 
 ) 
 

Validate rules for read options, and assign to the request.

See more: google.cloud.datastore.helpers.get_read_options

google.cloud.datastore.helpers.get_transaction_options

  get_transaction_options 
 ( 
 transaction 
 ) 
 

Get the transaction_id or new_transaction_options field from an active transaction object, for use in get_read_options.

See more: google.cloud.datastore.helpers.get_transaction_options

google.cloud.datastore.helpers.key_from_protobuf

  key_from_protobuf 
 ( 
 pb 
 ) 
 

Factory method for creating a key based on a protobuf.

See more: google.cloud.datastore.helpers.key_from_protobuf

google.cloud.datastore.helpers.set_database_id_to_request

  set_database_id_to_request 
 ( 
 request 
 , 
 database_id 
 = 
 None 
 ) 
 

Set the "database_id" field to the request only if it was provided.

See more: google.cloud.datastore.helpers.set_database_id_to_request

google.cloud.datastore.aggregation.AggregationQuery.add_aggregation

  add_aggregation 
 ( 
 aggregation 
 ) 
 

Adds an aggregation operation to the nested query .

See more: google.cloud.datastore.aggregation.AggregationQuery.add_aggregation

google.cloud.datastore.aggregation.AggregationQuery.add_aggregations

  add_aggregations 
 ( 
 aggregations 
 ) 
 

Adds a list of aggregations to the nested query.

See more: google.cloud.datastore.aggregation.AggregationQuery.add_aggregations

google.cloud.datastore.aggregation.AggregationQuery.avg

  avg 
 ( 
 property_ref 
 , 
 alias 
 = 
 None 
 ) 
 

Adds a avg over the nested query .

See more: google.cloud.datastore.aggregation.AggregationQuery.avg

google.cloud.datastore.aggregation.AggregationQuery.count

  count 
 ( 
 alias 
 = 
 None 
 ) 
 

Adds a count over the nested query .

See more: google.cloud.datastore.aggregation.AggregationQuery.count

google.cloud.datastore.aggregation.AggregationQuery.fetch

  fetch 
 ( 
 client 
 = 
 None 
 , 
 limit 
 = 
 None 
 , 
 eventual 
 = 
 False 
 , 
 retry 
 = 
 None 
 , 
 timeout 
 = 
 None 
 , 
 read_time 
 = 
 None 
 ) 
 

Execute the Aggregation Query; return an iterator for the aggregation results.

See more: google.cloud.datastore.aggregation.AggregationQuery.fetch

google.cloud.datastore.aggregation.AggregationQuery.sum

  sum 
 ( 
 property_ref 
 , 
 alias 
 = 
 None 
 ) 
 

Adds a sum over the nested query .

See more: google.cloud.datastore.aggregation.AggregationQuery.sum

google.cloud.datastore.batch.Batch.begin

  begin 
 () 
 

Begins a batch.

See more: google.cloud.datastore.batch.Batch.begin

google.cloud.datastore.batch.Batch.commit

  commit 
 ( 
 retry 
 = 
 None 
 , 
 timeout 
 = 
 None 
 ) 
 

Commits the batch.

See more: google.cloud.datastore.batch.Batch.commit

google.cloud.datastore.batch.Batch.current

  current 
 () 
 

Return the topmost batch / transaction, or None.

See more: google.cloud.datastore.batch.Batch.current

google.cloud.datastore.batch.Batch.delete

  delete 
 ( 
 key 
 ) 
 

Remember a key to be deleted during commit .

See more: google.cloud.datastore.batch.Batch.delete

google.cloud.datastore.batch.Batch.put

  put 
 ( 
 entity 
 ) 
 

Remember an entity's state to be saved during commit .

See more: google.cloud.datastore.batch.Batch.put

google.cloud.datastore.batch.Batch.rollback

  rollback 
 () 
 

Rolls back the current batch.

See more: google.cloud.datastore.batch.Batch.rollback

google.cloud.datastore.client.Client.aggregation_query

  aggregation_query 
 ( 
 query 
 , 
 ** 
 kwargs 
 ) 
 

Proxy to xref_AggregationQuery.

See more: google.cloud.datastore.client.Client.aggregation_query

google.cloud.datastore.client.Client.allocate_ids

  allocate_ids 
 ( 
 incomplete_key 
 , 
 num_ids 
 , 
 retry 
 = 
 None 
 , 
 timeout 
 = 
 None 
 ) 
 

Allocate a list of IDs from a partial key.

See more: google.cloud.datastore.client.Client.allocate_ids

google.cloud.datastore.client.Client.batch

  batch 
 () 
 

google.cloud.datastore.client.Client.delete

  delete 
 ( 
 key 
 , 
 retry 
 = 
 None 
 , 
 timeout 
 = 
 None 
 ) 
 

Delete the key in the Cloud Datastore.

See more: google.cloud.datastore.client.Client.delete

google.cloud.datastore.client.Client.delete_multi

  delete_multi 
 ( 
 keys 
 , 
 retry 
 = 
 None 
 , 
 timeout 
 = 
 None 
 ) 
 

Delete keys from the Cloud Datastore.

See more: google.cloud.datastore.client.Client.delete_multi

google.cloud.datastore.client.Client.entity

  entity 
 ( 
 key 
 = 
 None 
 , 
 exclude_from_indexes 
 = 
 ()) 
 

google.cloud.datastore.client.Client.get

  get 
 ( 
 key 
 , 
 missing 
 = 
 None 
 , 
 deferred 
 = 
 None 
 , 
 transaction 
 = 
 None 
 , 
 eventual 
 = 
 False 
 , 
 retry 
 = 
 None 
 , 
 timeout 
 = 
 None 
 , 
 read_time 
 = 
 None 
 , 
 ) 
 

Retrieve an entity from a single key (if it exists).

See more: google.cloud.datastore.client.Client.get

google.cloud.datastore.client.Client.get_multi

  get_multi 
 ( 
 keys 
 , 
 missing 
 = 
 None 
 , 
 deferred 
 = 
 None 
 , 
 transaction 
 = 
 None 
 , 
 eventual 
 = 
 False 
 , 
 retry 
 = 
 None 
 , 
 timeout 
 = 
 None 
 , 
 read_time 
 = 
 None 
 , 
 ) 
 

Retrieve entities, along with their attributes.

See more: google.cloud.datastore.client.Client.get_multi

google.cloud.datastore.client.Client.key

  key 
 ( 
 * 
 path_args 
 , 
 ** 
 kwargs 
 ) 
 

google.cloud.datastore.client.Client.put

  put 
 ( 
 entity 
 , 
 retry 
 = 
 None 
 , 
 timeout 
 = 
 None 
 ) 
 

Save an entity in the Cloud Datastore.

See more: google.cloud.datastore.client.Client.put

google.cloud.datastore.client.Client.put_multi

  put_multi 
 ( 
 entities 
 , 
 retry 
 = 
 None 
 , 
 timeout 
 = 
 None 
 ) 
 

Save entities in the Cloud Datastore.

See more: google.cloud.datastore.client.Client.put_multi

google.cloud.datastore.client.Client.query

  query 
 ( 
 ** 
 kwargs 
 ) 
 

Proxy to xref_Query.

See more: google.cloud.datastore.client.Client.query

google.cloud.datastore.client.Client.reserve_ids

  reserve_ids 
 ( 
 complete_key 
 , 
 num_ids 
 , 
 retry 
 = 
 None 
 , 
 timeout 
 = 
 None 
 ) 
 

Reserve a list of IDs sequentially from a complete key.

See more: google.cloud.datastore.client.Client.reserve_ids

google.cloud.datastore.client.Client.reserve_ids_multi

  reserve_ids_multi 
 ( 
 complete_keys 
 , 
 retry 
 = 
 None 
 , 
 timeout 
 = 
 None 
 ) 
 

Reserve IDs from a list of complete keys.

See more: google.cloud.datastore.client.Client.reserve_ids_multi

google.cloud.datastore.client.Client.reserve_ids_sequential

  reserve_ids_sequential 
 ( 
 complete_key 
 , 
 num_ids 
 , 
 retry 
 = 
 None 
 , 
 timeout 
 = 
 None 
 ) 
 

Reserve a list of IDs sequentially from a complete key.

See more: google.cloud.datastore.client.Client.reserve_ids_sequential

google.cloud.datastore.client.Client.transaction

  transaction 
 ( 
 ** 
 kwargs 
 ) 
 

Proxy to xref_Transaction.

See more: google.cloud.datastore.client.Client.transaction

google.cloud.datastore.entity.Entity.__eq__

  __eq__ 
 ( 
 other 
 ) 
 

Compare two entities for equality.

See more: google.cloud.datastore.entity.Entity. eq

google.cloud.datastore.entity.Entity.__ne__

  __ne__ 
 ( 
 other 
 ) 
 

Compare two entities for inequality.

See more: google.cloud.datastore.entity.Entity. ne

google.cloud.datastore.helpers.GeoPoint.__eq__

  __eq__ 
 ( 
 other 
 ) 
 

Compare two geo points for equality.

See more: google.cloud.datastore.helpers.GeoPoint. eq

google.cloud.datastore.helpers.GeoPoint.__ne__

  __ne__ 
 ( 
 other 
 ) 
 

Compare two geo points for inequality.

See more: google.cloud.datastore.helpers.GeoPoint. ne

google.cloud.datastore.helpers.GeoPoint.to_protobuf

  to_protobuf 
 () 
 

Convert the current object to protobuf.

See more: google.cloud.datastore.helpers.GeoPoint.to_protobuf

google.cloud.datastore.key.Key.__eq__

  __eq__ 
 ( 
 other 
 ) 
 

Compare two keys for equality.

See more: google.cloud.datastore.key.Key. eq

google.cloud.datastore.key.Key.__hash__

  __hash__ 
 () 
 

Hash this key for use in a dictionary lookup.

See more: google.cloud.datastore.key.Key. hash

google.cloud.datastore.key.Key.__ne__

  __ne__ 
 ( 
 other 
 ) 
 

Compare two keys for inequality.

See more: google.cloud.datastore.key.Key. ne

google.cloud.datastore.key.Key.__repr__

  __repr__ 
 () 
 

String representation of this key.

See more: google.cloud.datastore.key.Key. repr

google.cloud.datastore.key.Key.completed_key

  completed_key 
 ( 
 id_or_name 
 ) 
 

Creates new key from existing partial key by adding final ID/name.

See more: google.cloud.datastore.key.Key.completed_key

google.cloud.datastore.key.Key.from_legacy_urlsafe

  from_legacy_urlsafe 
 ( 
 urlsafe 
 ) 
 

Convert urlsafe string to xref_Key.

See more: google.cloud.datastore.key.Key.from_legacy_urlsafe

google.cloud.datastore.key.Key.to_legacy_urlsafe

  to_legacy_urlsafe 
 ( 
 location_prefix 
 = 
 None 
 ) 
 

Convert to a base64 encode urlsafe string for App Engine.

See more: google.cloud.datastore.key.Key.to_legacy_urlsafe

google.cloud.datastore.key.Key.to_protobuf

  to_protobuf 
 () 
 

Return a protobuf corresponding to the key.

See more: google.cloud.datastore.key.Key.to_protobuf

google.cloud.datastore.query.BaseCompositeFilter.build_pb

  build_pb 
 ( 
 container_pb 
 = 
 None 
 ) 
 

Build the protobuf representation based on values in the Composite Filter.

See more: google.cloud.datastore.query.BaseCompositeFilter.build_pb

google.cloud.datastore.query.BaseFilter.build_pb

  build_pb 
 ( 
 container_pb 
 = 
 None 
 ) 
 

Build the protobuf representation based on values in the Filter.

See more: google.cloud.datastore.query.BaseFilter.build_pb

google.cloud.datastore.query.PropertyFilter.build_pb

  build_pb 
 ( 
 container_pb 
 = 
 None 
 ) 
 

Build the protobuf representation based on values in the Property Filter.

See more: google.cloud.datastore.query.PropertyFilter.build_pb

google.cloud.datastore.query.Query.add_filter

  add_filter 
 ( 
 property_name 
 = 
 None 
 , 
 operator 
 = 
 None 
 , 
 value 
 = 
 None 
 , 
 * 
 , 
 filter 
 = 
 None 
 ) 
 

Filter the query based on a property name, operator and a value.

See more: google.cloud.datastore.query.Query.add_filter

google.cloud.datastore.query.Query.fetch

  fetch 
 ( 
 limit 
 = 
 None 
 , 
 offset 
 = 
 0 
 , 
 start_cursor 
 = 
 None 
 , 
 end_cursor 
 = 
 None 
 , 
 client 
 = 
 None 
 , 
 eventual 
 = 
 False 
 , 
 retry 
 = 
 None 
 , 
 timeout 
 = 
 None 
 , 
 read_time 
 = 
 None 
 , 
 ) 
 

Execute the Query; return an iterator for the matching entities.

See more: google.cloud.datastore.query.Query.fetch

google.cloud.datastore.query.Query.key_filter

  key_filter 
 ( 
 key 
 , 
 operator 
 = 
 "=" 
 ) 
 

google.cloud.datastore.query.Query.keys_only

  keys_only 
 () 
 

Set the projection to include only keys.

See more: google.cloud.datastore.query.Query.keys_only

google.cloud.datastore.transaction.Transaction.begin

  begin 
 ( 
 retry 
 = 
 None 
 , 
 timeout 
 = 
 None 
 ) 
 

google.cloud.datastore.transaction.Transaction.commit

  commit 
 ( 
 retry 
 = 
 None 
 , 
 timeout 
 = 
 None 
 ) 
 

Commits the transaction.

See more: google.cloud.datastore.transaction.Transaction.commit

google.cloud.datastore.transaction.Transaction.current

  current 
 () 
 

Return the topmost transaction.

See more: google.cloud.datastore.transaction.Transaction.current

google.cloud.datastore.transaction.Transaction.delete

  delete 
 ( 
 key 
 ) 
 

Remember a key to be deleted during commit .

See more: google.cloud.datastore.transaction.Transaction.delete

google.cloud.datastore.transaction.Transaction.put

  put 
 ( 
 entity 
 ) 
 

Adds an entity to be committed.

See more: google.cloud.datastore.transaction.Transaction.put

google.cloud.datastore.transaction.Transaction.rollback

  rollback 
 ( 
 retry 
 = 
 None 
 , 
 timeout 
 = 
 None 
 ) 
 

Rolls back the current transaction.

See more: google.cloud.datastore.transaction.Transaction.rollback

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient

  DatastoreAdminClient 
 ( 
 * 
 , 
 credentials 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 auth 
 . 
 credentials 
 . 
 Credentials 
 ] 
 = 
 None 
 , 
 transport 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 google 
 . 
 cloud 
 . 
 datastore_admin_v1 
 . 
 services 
 . 
 datastore_admin 
 . 
 transports 
 . 
 base 
 . 
 DatastoreAdminTransport 
 , 
 typing 
 . 
 Callable 
 [[ 
 ... 
 ], 
 google 
 . 
 cloud 
 . 
 datastore_admin_v1 
 . 
 services 
 . 
 datastore_admin 
 . 
 transports 
 . 
 base 
 . 
 DatastoreAdminTransport 
 ]]] 
 = 
 None 
 , 
 client_options 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 client_options 
 . 
 ClientOptions 
 , 
 dict 
 ]] 
 = 
 None 
 , 
 client_info 
 : 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 client_info 
 . 
 ClientInfo 
 = 
 

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.__exit__

  __exit__ 
 ( 
 type 
 , 
 value 
 , 
 traceback 
 ) 
 

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.cancel_operation

  cancel_operation 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 CancelOperationRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> None 
 

Starts asynchronous cancellation on a long-running operation.

See more: google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.cancel_operation

  common_billing_account_path 
 ( 
 billing_account 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.common_folder_path

  common_folder_path 
 ( 
 folder 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.common_location_path

  common_location_path 
 ( 
 project 
 : 
 str 
 , 
 location 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.common_organization_path

  common_organization_path 
 ( 
 organization 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.common_project_path

  common_project_path 
 ( 
 project 
 : 
 str 
 ) 
 - 
> str 
 

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.create_index

  create_index 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 datastore_admin_v1 
 . 
 types 
 . 
 datastore_admin 
 . 
 CreateIndexRequest 
 , 
 dict 
 , 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation 
 

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.delete_index

  delete_index 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 datastore_admin_v1 
 . 
 types 
 . 
 datastore_admin 
 . 
 DeleteIndexRequest 
 , 
 dict 
 , 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation 
 

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.delete_operation

  delete_operation 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 DeleteOperationRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> None 
 

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.export_entities

  export_entities 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 datastore_admin_v1 
 . 
 types 
 . 
 datastore_admin 
 . 
 ExportEntitiesRequest 
 , 
 dict 
 , 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 project_id 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 labels 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 MutableMapping 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 None 
 , 
 entity_filter 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 datastore_admin_v1 
 . 
 types 
 . 
 datastore_admin 
 . 
 EntityFilter 
 ] 
 = 
 None 
 , 
 output_url_prefix 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation 
 

Exports a copy of all or a subset of entities from Google Cloud Datastore to another storage system, such as Google Cloud Storage.

See more: google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.export_entities

  from_service_account_file 
 ( 
 filename 
 : 
 str 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

Creates an instance of this client using the provided credentials file.

See more: google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.from_service_account_file

  from_service_account_info 
 ( 
 info 
 : 
 dict 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

Creates an instance of this client using the provided credentials info.

See more: google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.from_service_account_info

  from_service_account_json 
 ( 
 filename 
 : 
 str 
 , 
 * 
 args 
 , 
 ** 
 kwargs 
 ) 
 

Creates an instance of this client using the provided credentials file.

See more: google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.from_service_account_json

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.get_index

  get_index 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 datastore_admin_v1 
 . 
 types 
 . 
 datastore_admin 
 . 
 GetIndexRequest 
 , 
 dict 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 datastore_admin_v1 
 . 
 types 
 . 
 index 
 . 
 Index 
 

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.get_mtls_endpoint_and_cert_source

  get_mtls_endpoint_and_cert_source 
 ( 
 client_options 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 api_core 
 . 
 client_options 
 . 
 ClientOptions 
 ] 
 = 
 None 
 , 
 ) 
 

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.get_operation

  get_operation 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 GetOperationRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 Operation 
 

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.import_entities

  import_entities 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 datastore_admin_v1 
 . 
 types 
 . 
 datastore_admin 
 . 
 ImportEntitiesRequest 
 , 
 dict 
 , 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 project_id 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 labels 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 MutableMapping 
 [ 
 str 
 , 
 str 
 ]] 
 = 
 None 
 , 
 input_url 
 : 
 typing 
 . 
 Optional 
 [ 
 str 
 ] 
 = 
 None 
 , 
 entity_filter 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 cloud 
 . 
 datastore_admin_v1 
 . 
 types 
 . 
 datastore_admin 
 . 
 EntityFilter 
 ] 
 = 
 None 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 api_core 
 . 
 operation 
 . 
 Operation 
 

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.list_indexes

  list_indexes 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 cloud 
 . 
 datastore_admin_v1 
 . 
 types 
 . 
 datastore_admin 
 . 
 ListIndexesRequest 
 , 
 dict 
 , 
 ] 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 cloud 
 . 
 datastore_admin_v1 
 . 
 services 
 . 
 datastore_admin 
 . 
 pagers 
 . 
 ListIndexesPager 
 

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.list_operations

  list_operations 
 ( 
 request 
 : 
 typing 
 . 
 Optional 
 [ 
 google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 ListOperationsRequest 
 ] 
 = 
 None 
 , 
 * 
 , 
 retry 
 : 
 typing 
 . 
 Optional 
 [ 
 typing 
 . 
 Union 
 [ 
 google 
 . 
 api_core 
 . 
 retry 
 . 
 retry_unary 
 . 
 Retry 
 , 
 google 
 . 
 api_core 
 . 
 gapic_v1 
 . 
 method 
 . 
 _MethodDefault 
 , 
 ] 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 timeout 
 : 
 typing 
 . 
 Union 
 [ 
 float 
 , 
 object 
 ] 
 = 
 _MethodDefault 
 . 
 _DEFAULT_VALUE 
 , 
 metadata 
 : 
 typing 
 . 
 Sequence 
 [ 
 typing 
 . 
 Tuple 
 [ 
 str 
 , 
 typing 
 . 
 Union 
 [ 
 str 
 , 
 bytes 
 ]]] 
 = 
 () 
 ) 
 - 
> google 
 . 
 longrunning 
 . 
 operations_pb2 
 . 
 ListOperationsResponse 
 

Lists operations that match the specified filter in the request.

See more: google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.list_operations

  parse_common_billing_account_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.parse_common_folder_path

  parse_common_folder_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.parse_common_location_path

  parse_common_location_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.parse_common_organization_path

  parse_common_organization_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 

google.cloud.datastore_admin_v1.services.datastore_admin.client.DatastoreAdminClient.parse_common_project_path

  parse_common_project_path 
 ( 
 path 
 : 
 str 
 ) 
 - 
> typing 
 . 
 Dict 
 [ 
 str 
 , 
 str 
 ] 
 
Design a Mobile Site
View Site in Mobile | Classic
Share by: