api.datastores.v1 package

Submodules

api.datastores.v1.descriptor module

Autogenerated API

api.datastores.v1.descriptor.add_data_store_descriptor(name: str = None, description: str = None, lifeTime: int = None, behaviourType: str = 'CENTRAL', dataType: str = 'MAP (key/value store)', globalData: bool = 'False', expireData: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Adds a new datastore descriptor. (PUBLIC)

Return type:

dict

Parameters:
  • name (str) – Name for new datastore. Name must be unique. => [a-zA-Z0-9_-.]*
  • description (str) – Description of the datastore. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • lifeTime (int) – The requested expiry time in milliseconds. Requires a positive value (if expireData is true).
  • behaviourType (str) – Datastore behaviour. CENTRAL stores are only updated centrally, but may be used in distributed processing. LOCAL and DISTRIBUTED stores are not stored centrally, but updated in the distributed system. DISTRIBUTED may be shared between processing nodes. (default CENTRAL)
  • dataType (str) – Select data type: list of values or key/value store. (default MAP (key/value store))
  • globalData (bool) – If true, datastore only accepts global data (not customer bound).
  • expireData (bool) – If true, datastore entries will expire after the configured time period since added/last updated.
Raises:
Returns:

{“offset”: 457, “limit”: 722, “responseCode”: 200, “count”: 964, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Smile why popular trade television property trial mother.”, “messageTemplate”: “Middle report type four five voice identify concern.”, “field”: “Kid business already approach.”, “parameter”: {}, “timestamp”: 398701448}], “currentPage”: 353, “size”: 45}

api.datastores.v1.descriptor.delete_data_store_descriptor(dataStore: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Deletes an existing datastore descriptor. (PUBLIC)

Return type:

dict

Parameters:

dataStore (str) – Store name

Raises:
Returns:

{“offset”: 55, “limit”: 934, “responseCode”: 200, “count”: 5, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Instead direction score ask amount kind Mr.”, “messageTemplate”: “Foot receive military travel physical.”, “field”: “Song certainly recently side social.”, “parameter”: {}, “timestamp”: 1308779326}], “currentPage”: 631, “size”: 86}

api.datastores.v1.descriptor.get_descriptor(dataStore: str, json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns a Datastore descriptor identified by its name. (PUBLIC)

Return type:

dict

Parameters:

dataStore (str) – Descriptor name

Raises:
Returns:

{“offset”: 531, “limit”: 773, “responseCode”: 200, “count”: 19, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Show yourself dinner even common.”, “messageTemplate”: “Heavy design ok situation unit.”, “field”: “Money benefit gun choose ball.”, “parameter”: {}, “timestamp”: 318351389}], “currentPage”: 57, “size”: 919}

api.datastores.v1.descriptor.search_descriptors(limit: int = None, offset: int = None, includeFlags: int = None, excludeFlags: int = None, subCriteria: list = None, keywords: list = None, keywordFieldStrategy: list = None, keywordMatchStrategy: str = None, sortBy: list = None, includeDeleted: bool = 'False', exclude: bool = 'False', required: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns an array of DataStore descriptors matching search criteria (PUBLIC)

Return type:

dict

Parameters:
  • 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.
  • includeFlags (int) – Only include objects which have includeFlags set.
  • excludeFlags (int) – Exclude objects which have excludeFlags set.
  • subCriteria (list) –
  • keywords (list) – Search for datastores matching keyword
  • keywordFieldStrategy (list) – Defines which fields will be searched by keywords (default all supported fields).
  • keywordMatchStrategy (str) – Defines the MatchStrategy for keywords (default match all keywords).
  • sortBy (list) – List of properties to sort by (prefix with “-” to sort descending).
  • 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”: 357, “limit”: 291, “responseCode”: 200, “count”: 534, “data”: [{“name”: “Sharon Smith”, “description”: “Budget increase certain.”, “dataType”: “LIST”, “behaviourType”: “CENTRAL”, “lastUpdatedTimestamp”: 639947711, “lastUpdatedByUser”: {“id”: 942, “customerID”: 687, “userName”: “jamieadams”, “name”: “Jonathan Davis”}, “lifeTime”: 669, “deleted”: true, “globalData”: true, “expireData”: true}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Until read report article plant mind.”, “messageTemplate”: “Require Congress growth gun majority.”, “field”: “Word nation firm market.”, “parameter”: {}, “timestamp”: 464400886}], “currentPage”: 633, “size”: 60}

api.datastores.v1.descriptor.search_descriptors_simple(keywords: list = None, keywordField: list = None, sortBy: list = None, offset: int = 0, limit: int = 25, keywordMatch: str = 'all', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Returns an array of DataStore descriptors matching search parameters (PUBLIC)

Return type:

dict

Parameters:
  • keywords (list) – Search by keywords
  • keywordField (list) – Set field strategy for keyword search
  • sortBy (list) – Sort search result
  • offset (int) – Skip a number of results
  • limit (int) – Maximum number of returned results
  • keywordMatch (str) – Set match strategy for keyword search
Raises:
Returns:

{“offset”: 650, “limit”: 74, “responseCode”: 200, “count”: 334, “data”: [{“name”: “James Knight”, “description”: “Movement campaign huge indicate every.”, “dataType”: “LIST”, “behaviourType”: “DISTRIBUTED”, “lastUpdatedTimestamp”: 109189894, “lastUpdatedByUser”: {“id”: 939, “customerID”: 869, “userName”: “diane57”, “name”: “Beverly Weaver”}, “lifeTime”: 508, “deleted”: true, “globalData”: true, “expireData”: false}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Explain cold say control short physical.”, “messageTemplate”: “Book newspaper writer final professional.”, “field”: “Listen dinner arrive.”, “parameter”: {}, “timestamp”: 1132884717}], “currentPage”: 142, “size”: 863}

api.datastores.v1.descriptor.update_data_store_descriptor(dataStore: str, name: str = None, description: str = None, lifeTime: int = None, globalData: bool = 'False', expireData: bool = 'False', json: bool = True, verify: bool = True, apiKey: str = '', authentication: dict = {}) → dict[source]

Updates an existing datastore descriptor. (PUBLIC)

Return type:

dict

Parameters:
  • dataStore (str) – Store name
  • name (str) – If set, request datastore to change name. All entries will be updated (so may take long time for large stores). => [a-zA-Z0-9_-.]*
  • description (str) – If set, update description on datastore. => [sw{}$-().[]“‘_/,*+#:@!?;]*
  • lifeTime (int) – If set (to positive value), change the expiry time for this datastore. Requires that the store has enabled expireData. Default is no change.
  • globalData (bool) – If set, change the global data flag on this datastore. Default is no change.
  • expireData (bool) – If set, change the expire data flag on this datastore. Default is no change.
Raises:
Returns:

{“offset”: 528, “limit”: 763, “responseCode”: 200, “count”: 910, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Program put condition take car tonight.”, “messageTemplate”: “Senior why describe.”, “field”: “Appear participant left agent management.”, “parameter”: {}, “timestamp”: 962065228}], “currentPage”: 861, “size”: 345}

Module contents