api.datastores.v1 package¶
Subpackages¶
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 = None, expireData: bool = None, json: bool = True, verify: bool = True, apiKey: str = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {‘offset’: 190, ‘limit’: 608, ‘responseCode’: 200, ‘count’: 107, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Rich food dog thousand about certainly.’, ‘messageTemplate’: ‘Seem but cut dream owner actually Republican.’, ‘field’: ‘Data child analysis media show believe.’, ‘parameter’: {}, ‘timestamp’: 191829769}], ‘currentPage’: 814, ‘size’: 112}
-
api.datastores.v1.descriptor.
delete_data_store_descriptor
(dataStore: str, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]¶ Deletes an existing datastore descriptor. (PUBLIC)
Return type: dict
Parameters: dataStore (str) – Store name
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- StoreNotFoundException – on 404
Returns: {‘offset’: 955, ‘limit’: 956, ‘responseCode’: 200, ‘count’: 384, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Project way bring.’, ‘messageTemplate’: ‘Large him include between machine.’, ‘field’: ‘Represent fly describe smile board.’, ‘parameter’: {}, ‘timestamp’: 25307198}], ‘currentPage’: 355, ‘size’: 176}
-
api.datastores.v1.descriptor.
get_descriptor
(dataStore: str, json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]¶ Returns a Datastore descriptor identified by its name. (PUBLIC)
Return type: dict
Parameters: dataStore (str) – Descriptor name
Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {‘offset’: 919, ‘limit’: 203, ‘responseCode’: 200, ‘count’: 262, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘In form watch street million well current.’, ‘messageTemplate’: ‘Feeling store particular light.’, ‘field’: ‘Cup son be much student rise population debate.’, ‘parameter’: {}, ‘timestamp’: 466354306}], ‘currentPage’: 634, ‘size’: 601}
-
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 = None, exclude: bool = None, required: bool = None, json: bool = True, verify: bool = True, apiKey: str = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {‘offset’: 396, ‘limit’: 167, ‘responseCode’: 200, ‘count’: 297, ‘data’: [{‘name’: ‘Michael Pacheco’, ‘description’: ‘Hot collection price building interest threat involve.’, ‘dataType’: ‘LIST’, ‘behaviourType’: ‘LOCAL’, ‘lastUpdatedTimestamp’: 1101012323, ‘lastUpdatedByUser’: {‘id’: 28, ‘customerID’: 716, ‘userName’: ‘theresamaxwell’, ‘name’: ‘Christopher Mckenzie’}, ‘lifeTime’: 652, ‘deleted’: False, ‘globalData’: True, ‘expireData’: False}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Rock her full whatever pass speak eat.’, ‘messageTemplate’: ‘Ball real door cover past prepare.’, ‘field’: ‘Stock in bag production.’, ‘parameter’: {}, ‘timestamp’: 294090934}], ‘currentPage’: 973, ‘size’: 11}
-
api.datastores.v1.descriptor.
search_descriptors_simple
(keywords: list = None, keywordField: list = None, sortBy: list = None, offset: int = None, limit: int = 25, keywordMatch: str = 'all', json: bool = True, verify: bool = True, apiKey: str = None, authentication: dict = {}) → dict[source]¶ Returns an array of DataStore descriptors matching search parameters (PUBLIC)
Return type: dict
Parameters: Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {‘offset’: 518, ‘limit’: 658, ‘responseCode’: 200, ‘count’: 312, ‘data’: [{‘name’: ‘James Pacheco’, ‘description’: ‘Black himself sense.’, ‘dataType’: ‘MAP’, ‘behaviourType’: ‘LOCAL’, ‘lastUpdatedTimestamp’: 652063070, ‘lastUpdatedByUser’: {‘id’: 351, ‘customerID’: 245, ‘userName’: ‘selena80’, ‘name’: ‘Cynthia Kelly’}, ‘lifeTime’: 201, ‘deleted’: True, ‘globalData’: True, ‘expireData’: False}], ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Consider quality personal.’, ‘messageTemplate’: ‘Forward popular reach price store technology name.’, ‘field’: ‘Research doctor imagine.’, ‘parameter’: {}, ‘timestamp’: 881898652}], ‘currentPage’: 772, ‘size’: 442}
-
api.datastores.v1.descriptor.
update_data_store_descriptor
(dataStore: str, name: str = None, description: str = None, lifeTime: int = None, globalData: bool = None, expireData: bool = None, json: bool = True, verify: bool = True, apiKey: str = None, 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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- StoreNotFoundException – on 404
Returns: {‘offset’: 577, ‘limit’: 842, ‘responseCode’: 200, ‘count’: 955, ‘metaData’: {‘additionalProperties’: {}}, ‘messages’: [{‘message’: ‘Rise work strategy example.’, ‘messageTemplate’: ‘Difficult own special.’, ‘field’: ‘Level either ahead.’, ‘parameter’: {}, ‘timestamp’: 948064984}], ‘currentPage’: 88, ‘size’: 849}