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 = '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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {“offset”: 381, “limit”: 366, “responseCode”: 200, “count”: 821, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Edge build law generation follow.”, “messageTemplate”: “And center rest bad.”, “field”: “Door same entire.”, “parameter”: {}, “timestamp”: 1242926809}], “currentPage”: 767, “size”: 323}
-
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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- StoreNotFoundException – on 404
Returns: {“offset”: 441, “limit”: 649, “responseCode”: 200, “count”: 844, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Represent sometimes sister Mr population.”, “messageTemplate”: “My six against.”, “field”: “Hear stop ever forget prove throw through.”, “parameter”: {}, “timestamp”: 350783522}], “currentPage”: 606, “size”: 634}
-
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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- ObjectNotFoundException – on 404
Returns: {“offset”: 633, “limit”: 397, “responseCode”: 200, “count”: 81, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “People his industry guy region song week.”, “messageTemplate”: “Past box painting over.”, “field”: “Focus effect soon girl.”, “parameter”: {}, “timestamp”: 1343520909}], “currentPage”: 848, “size”: 712}
-
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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {“offset”: 13, “limit”: 279, “responseCode”: 200, “count”: 947, “data”: [{“name”: “Valerie Perez”, “description”: “Win eight so card finally kid several.”, “dataType”: “LIST”, “behaviourType”: “LOCAL”, “lastUpdatedTimestamp”: 812957069, “lastUpdatedByUser”: {“id”: 848, “customerID”: 748, “userName”: “morganlori”, “name”: “Ryan Barr”}, “lifeTime”: 715, “deleted”: true, “globalData”: true, “expireData”: false}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Buy shoulder feeling area.”, “messageTemplate”: “Half once attention would east somebody.”, “field”: “Billion benefit learn learn eat allow citizen.”, “parameter”: {}, “timestamp”: 1223681423}], “currentPage”: 730, “size”: 915}
-
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: Raises: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
Returns: {“offset”: 853, “limit”: 313, “responseCode”: 200, “count”: 40, “data”: [{“name”: “Edward Gomez”, “description”: “Away simple energy peace tree institution thought dark.”, “dataType”: “MAP”, “behaviourType”: “CENTRAL”, “lastUpdatedTimestamp”: 1388269322, “lastUpdatedByUser”: {“id”: 392, “customerID”: 833, “userName”: “kcampbell”, “name”: “Dustin Rodriguez”}, “lifeTime”: 122, “deleted”: true, “globalData”: true, “expireData”: true}], “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Win eat support movie decide figure.”, “messageTemplate”: “Cause star other amount control job learn.”, “field”: “Ask watch recognize song customer her.”, “parameter”: {}, “timestamp”: 1029462630}], “currentPage”: 115, “size”: 341}
-
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: - AuthenticationFailedException – on 401
- ValidationErrorException – on 412
- AccessDeniedException – on 403
- StoreNotFoundException – on 404
Returns: {“offset”: 378, “limit”: 173, “responseCode”: 200, “count”: 813, “metaData”: {“additionalProperties”: {}}, “messages”: [{“message”: “Most hard building.”, “messageTemplate”: “Put program wait quality party provide.”, “field”: “Suffer pretty important drug law.”, “parameter”: {}, “timestamp”: 541441206}], “currentPage”: 64, “size”: 87}