api.datastores.v1.store package

Submodules

api.datastores.v1.store.store module

Autogenerated API

api.datastores.v1.store.store.delete_data_store_entries(dataStore: str, key: list = None, customerID: int = None, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Deletes the specified datastore entries for the specified store. (PUBLIC)

Return type:

dict

Parameters:
  • dataStore (str) – Store name
  • key (list) – Datastore keys to delete
  • customerID (int) – Specify datastore to delete entries from (default is users customer)
Raises:
Returns:

{‘offset’: 604, ‘limit’: 346, ‘responseCode’: 200, ‘count’: 67, ‘data’: [{‘dataStoreName’: ‘Various eye personal start.’, ‘lastUpdatedTimestamp’: 456144997, ‘lastUpdatedByUser’: {‘id’: 538, ‘customerID’: 219, ‘userName’: ‘ricelouis’, ‘name’: ‘Frederick Francis’}, ‘key’: ‘Right former behavior somebody.’, ‘value’: ‘Majority official piece.’, ‘flags’: [‘DELETED’]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Especially reflect institution memory ago place.’, ‘messageTemplate’: ‘Pretty include trip.’, ‘field’: ‘Better majority example police hold.’, ‘parameter’: {}, ‘timestamp’: 1300688137}], ‘currentPage’: 949, ‘size’: 897}

api.datastores.v1.store.store.get_entries_from_store(dataStore: str, limit: int = None, offset: int = None, subCriteria: list = None, customerID: list = None, userID: list = None, key: list = None, fromKey: str = None, toKey: str = None, startTimestamp: int = None, endTimestamp: int = None, sortBy: list = None, includeFlags: list = None, excludeFlags: list = None, includeDeleted: bool = None, exclude: bool = None, required: bool = None, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Returns datastore entries for the specified store, matching the search criteria. (PUBLIC)

Return type:

dict

Parameters:
  • dataStore (str) – Store name
  • limit (int) – Set this value to set max number of results. By default, no restriction on result set size.
  • offset (int) – Set this value to skip the first (offset) objects. By default, return result from first object.
  • subCriteria (list) –
  • customerID (list) – Restrict search to data belonging to specified customers.
  • userID (list) – Restrict search to entries which was last updated by specified users.
  • key (list) – Restrict search to the specified key (entries).
  • fromKey (str) – Restrict search to entries (map keys) which are greater than this key (including, by lexical order).
  • toKey (str) – Restrict search to entries (map keys) which are less than this key (including, by lexical order).
  • startTimestamp (int) – Restrict search to entries which are last updated after this timestamp (including).
  • endTimestamp (int) – Restrict search to entries which are last updated before this timestamp (including).
  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).
  • includeFlags (list) – Only include objects which have includeFlags set.
  • excludeFlags (list) – Exclude objects which have excludeFlags set.
  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.
  • exclude (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria object will be excluded.
  • required (bool) – Only relevant for subcriteria. If set to true, objects matching this subcriteria are required (AND-ed together with parent criteria).
Raises:
Returns:

{‘offset’: 695, ‘limit’: 826, ‘responseCode’: 200, ‘count’: 705, ‘data’: [{‘dataStoreName’: ‘Movie morning concern.’, ‘lastUpdatedTimestamp’: 1379177680, ‘lastUpdatedByUser’: {‘id’: 467, ‘customerID’: 816, ‘userName’: ‘iwilson’, ‘name’: ‘Jeffrey Stewart’}, ‘key’: ‘Cold across crime social.’, ‘value’: ‘Performance simply word system modern exactly.’, ‘flags’: [‘DELETED’]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Line rate morning seem main future policy turn.’, ‘messageTemplate’: ‘Fund window song remember quickly despite success deal.’, ‘field’: ‘Game wear safe western despite yourself nothing.’, ‘parameter’: {}, ‘timestamp’: 983908002}], ‘currentPage’: 708, ‘size’: 24}

api.datastores.v1.store.store.get_entries_from_store_simplified(dataStore: str, customerID: list = None, key: list = None, offset: int = None, limit: int = 25, includeDeleted: bool = True, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Returns datastore entries for the specified store, matching query parameters. (PUBLIC)

Return type:

dict

Parameters:
  • dataStore (str) – Store name
  • customerID (list) – Limit search to entries for the specified customers
  • key (list) – Limit search to the specified entry keys
  • offset (int) – Skip a number of results
  • limit (int) – Maximum number of returned results
  • includeDeleted (bool) – Include deleted/expired keys
Raises:
Returns:

{‘offset’: 728, ‘limit’: 321, ‘responseCode’: 200, ‘count’: 666, ‘data’: [{‘dataStoreName’: ‘Seem end individual there understand medical.’, ‘lastUpdatedTimestamp’: 1501433753, ‘lastUpdatedByUser’: {‘id’: 629, ‘customerID’: 278, ‘userName’: ‘qeverett’, ‘name’: ‘John Jordan’}, ‘key’: ‘Commercial listen main.’, ‘value’: ‘Control still what into month.’, ‘flags’: [‘DELETED’]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Find modern Mrs never north time.’, ‘messageTemplate’: ‘Age quickly accept create.’, ‘field’: ‘Fall fact yeah nearly according community yourself.’, ‘parameter’: {}, ‘timestamp’: 1293946015}], ‘currentPage’: 399, ‘size’: 970}

api.datastores.v1.store.store.get_single_entry(dataStore: str, key: str, customerID: int = None, includeDeleted: bool = True, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Returns the specified datastore entry for the specified store, or null if it does not exist (PUBLIC)

Return type:

dict

Parameters:
  • dataStore (str) – Store name
  • key (str) – Key to search
  • customerID (int) – Search specified customer store for this key (default is users customer)
  • includeDeleted (bool) – Include deleted/expired key
Raises:
Returns:

{‘offset’: 215, ‘limit’: 586, ‘responseCode’: 200, ‘count’: 566, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Someone true prevent body.’, ‘messageTemplate’: ‘Property career finally dark current.’, ‘field’: ‘City born east one write maybe person.’, ‘parameter’: {}, ‘timestamp’: 598061804}], ‘currentPage’: 815, ‘size’: 289}

api.datastores.v1.store.store.put_data_store_entries(dataStore: str, customerID: int = None, entries: list = None, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Updates the provided datastore entries for the specified store. (PUBLIC)

Return type:

dict

Parameters:
  • dataStore (str) – Store name
  • customerID (int) – ID of customer to bind data to. If not set, default is to bind to the current users customer (or none, if datastore is global)
  • entries (list) – Entries to add
Raises:
Returns:

{‘offset’: 860, ‘limit’: 412, ‘responseCode’: 200, ‘count’: 93, ‘data’: [{‘dataStoreName’: ‘True early truth left population.’, ‘lastUpdatedTimestamp’: 1278211288, ‘lastUpdatedByUser’: {‘id’: 84, ‘customerID’: 333, ‘userName’: ‘pjones’, ‘name’: ‘Andrew Mueller’}, ‘key’: ‘Yourself down child age always.’, ‘value’: ‘Hit beautiful low.’, ‘flags’: [‘DELETED’]}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Wide matter plan.’, ‘messageTemplate’: ‘Goal others interview describe.’, ‘field’: ‘Top anyone involve resource.’, ‘parameter’: {}, ‘timestamp’: 1374768256}], ‘currentPage’: 917, ‘size’: 85}

api.datastores.v1.store.store.put_single_data_store_entry(dataStore: str, key: str, customerID: int = None, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]

Adds the provided datastore entry for the specified store. To use for lists (key, no value) (PUBLIC)

Return type:

dict

Parameters:
  • dataStore (str) – Store name
  • key (str) – Datastore key to set
  • customerID (int) – Specify datastore to put entry to (default is users customer)
Raises:
Returns:

{‘offset’: 254, ‘limit’: 546, ‘responseCode’: 200, ‘count’: 161, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Show design hold town suddenly let.’, ‘messageTemplate’: ‘Not paper suggest realize nice.’, ‘field’: ‘Large include page guy eat.’, ‘parameter’: {}, ‘timestamp’: 1366589543}], ‘currentPage’: 823, ‘size’: 644}

Module contents