descriptor#

Autogenerated API

argus_api.lib.datastores.v1.descriptor.add_data_store_descriptor(name: str = None, description: str = None, globalData: bool = None, expireData: bool = None, lifeTime: int = None, behaviourType: str = None, dataType: str = None, useLowerCaseKeys: bool = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Adds a new datastore descriptor. (PUBLIC)

Parameters

  • name (str) – Name for the new datastore, must be unique. => [a-zA-Z0-9_:\-.]*

  • description (str) – A textual description of the datastore. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • globalData (bool) – If true, the datastore only accepts global data (not customer bound).

  • expireData (bool) – If true, the datastore entries will expire after the configured time period since added/last updated.

  • lifeTime (int) – The requested expiry time in milliseconds. Requires a positive value (if expireData is true).

  • behaviourType (str) – The behaviour of the datastore. CENTRAL datastores are only updated centrally, but may be used in distributed processing. LOCAL and DISTRIBUTED datastores are not stored centrally, but updated in the distributed system. DISTRIBUTED may be shared between processing nodes. (default CENTRAL)

  • dataType (str) – The type of data stored in the datastore (MAP or LIST). Maps have keys with values, lists only have keys. (default MAP)

  • useLowerCaseKeys (bool) – Boolean flag that determines whether to use lower case keys. (default false)

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.datastores.v1.descriptor.delete_data_store_descriptor(dataStore: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Deletes an existing datastore descriptor. (PUBLIC)

Parameters

  • dataStore (str) – Store name

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.datastores.v1.descriptor.get_descriptor(dataStore: str, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

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

Parameters

  • dataStore (str) – Store name

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.datastores.v1.descriptor.search_descriptors(limit: int = None, offset: int = None, includeDeleted: bool = None, includeFlags: int = None, excludeFlags: int = None, subCriteria: dict = None, exclude: bool = None, required: bool = None, keywords: str = None, keywordFieldStrategy: str = None, keywordMatchStrategy: str = None, sortBy: str = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns an array of datastore descriptors matching search criteria. (PUBLIC)

Parameters

  • limit (int) – Max number of results.

  • offset (int) – Skip the first (offset) objects. By default, return result from first object.

  • includeDeleted (bool) – Set to true to include deleted objects. By default, exclude deleted objects.

  • includeFlags (int) – Only include objects which have includeFlags set.

  • excludeFlags (int) – Exclude objects which have excludeFlags set.

  • subCriteria (list) – Set additional criterias which are applied using a logical OR.

  • 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).

  • keywords (list) – Search for datastores matching keywords.

  • 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).

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.datastores.v1.descriptor.search_descriptors_simple(keywords: str = None, keywordField: str = None, sortBy: str = None, limit: int = 25, keywordMatch: str = 'all', offset: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Returns an array of datastore descriptors matching search parameters. (PUBLIC)

Parameters

  • keywords (list) – Search by keywords

  • keywordField (list) – Set field strategy for keyword search

  • sortBy (list) – Sort search result

  • limit (int) – Maximum number of returned results

  • keywordMatch (str) – Set match strategy for keyword search

  • offset (int) – Skip a number of results

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON

argus_api.lib.datastores.v1.descriptor.update_data_store_descriptor(dataStore: str, name: str = None, description: str = None, globalData: bool = None, expireData: bool = None, lifeTime: int = None, json: bool = True, verify: Optional[bool] = None, proxies: Optional[dict] = None, apiKey: Optional[str] = None, authentication: Optional[dict] = None, server_url: Optional[str] = None, body: Optional[dict] = None, api_session: Optional[ArgusAPISession] = None) → dict#

Updates an existing datastore descriptor. (PUBLIC)

Parameters

  • dataStore (str) – Store name

  • name (str) – If set, change the name of this datastore. All entries will be updated (may take long time for large stores). => [a-zA-Z0-9_:\-.]*

  • description (str) – If set, change the textual description of this datastore. => [sw\{\}\$\-\(\).\[\]”'_/\,\*\+\#:@!?;=]*

  • 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.

  • lifeTime (int) – If set (to a positive value), change the expiry time of this datastore. Requires that the store has enabled expireData. Default is no change.

  • json – return the response’s body as a dict parsed from json. True by default. If set to false, the raw requests.Response object will be returned.

  • verify – path to a certificate bundle or boolean indicating whether SSL verification should be performed.

  • apiKey – Argus API key.

  • authentication – authentication override

  • server_url – API base URL override

  • body – body of the request. other parameters will override keys defined in the body.

  • api_session – session to use for this request. If not set, the global session will be used.

Raises
Returns

dictionary translated from JSON