sdk.lusid.api.check_definitions_api.CheckDefinitionsApi

class CheckDefinitionsApi(api_client=None)[source]

NOTE: This class is auto generated by OpenAPI Generator Ref: https://openapi-generator.tech

Do not edit the class manually.

Methods

create_check_definition

[EXPERIMENTAL] CreateCheckDefinition: Create a Check Definition # noqa: E501

create_check_definition_with_http_info

[EXPERIMENTAL] CreateCheckDefinition: Create a Check Definition # noqa: E501

delete_check_definition

[EXPERIMENTAL] DeleteCheckDefinition: Deletes a particular Check Definition # noqa: E501

delete_check_definition_with_http_info

[EXPERIMENTAL] DeleteCheckDefinition: Deletes a particular Check Definition # noqa: E501

delete_rules

[EXPERIMENTAL] DeleteRules: Delete rules on a particular Check Definition # noqa: E501

delete_rules_with_http_info

[EXPERIMENTAL] DeleteRules: Delete rules on a particular Check Definition # noqa: E501

get_check_definition

[EXPERIMENTAL] GetCheckDefinition: Get a single Check Definition by scope and code.

get_check_definition_with_http_info

[EXPERIMENTAL] GetCheckDefinition: Get a single Check Definition by scope and code.

list_check_definitions

[EXPERIMENTAL] ListCheckDefinitions: List Check Definitions # noqa: E501

list_check_definitions_with_http_info

[EXPERIMENTAL] ListCheckDefinitions: List Check Definitions # noqa: E501

run_check_definition

[EXPERIMENTAL] RunCheckDefinition: Runs a Check Definition against given dataset.

run_check_definition_with_http_info

[EXPERIMENTAL] RunCheckDefinition: Runs a Check Definition against given dataset.

update_check_definition

[EXPERIMENTAL] UpdateCheckDefinition: Update Check Definition defined by scope and code # noqa: E501

update_check_definition_with_http_info

[EXPERIMENTAL] UpdateCheckDefinition: Update Check Definition defined by scope and code # noqa: E501

upsert_rules

[EXPERIMENTAL] UpsertRules: Upsert rules to a particular Check Definition # noqa: E501

upsert_rules_with_http_info

[EXPERIMENTAL] UpsertRules: Upsert rules to a particular Check Definition # noqa: E501
create_check_definition(create_check_definition_request=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] CreateCheckDefinition: Create a Check Definition # noqa: E501

Creates a Check Definition. Returns the created Check Definition at the current effectiveAt. Note that Check Definitions are mono-temporal, however they can have Time-Variant Properties. Upserted Properties will be returned at the latest AsAt and EffectiveAt # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.create_check_definition(create_check_definition_request, async_req=True)
>>> result = thread.get()
Parameters:

  • create_check_definition_request (CreateCheckDefinitionRequest) – The request containing the details of the Check Definition

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _request_timeout – Timeout setting. Do not use - use the opts parameter instead

  • opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

CheckDefinition

create_check_definition_with_http_info(create_check_definition_request=None, **kwargs)[source]

[EXPERIMENTAL] CreateCheckDefinition: Create a Check Definition # noqa: E501

Creates a Check Definition. Returns the created Check Definition at the current effectiveAt. Note that Check Definitions are mono-temporal, however they can have Time-Variant Properties. Upserted Properties will be returned at the latest AsAt and EffectiveAt # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.create_check_definition_with_http_info(create_check_definition_request, async_req=True)
>>> result = thread.get()
Parameters:

  • create_check_definition_request (CreateCheckDefinitionRequest) – The request containing the details of the Check Definition

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – Timeout setting. Do not use - use the opts parameter instead

  • opts (ConfigurationOptions, optional) – Configuration options for this request

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(CheckDefinition, status_code(int), headers(HTTPHeaderDict))

delete_check_definition(scope, code, async_req=None, **kwargs)[source]

[EXPERIMENTAL] DeleteCheckDefinition: Deletes a particular Check Definition # noqa: E501

The deletion will take effect from the Check Definition deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_check_definition(scope, code, async_req=True)
>>> result = thread.get()
Parameters:

  • scope (str) – The scope of the specified Check Definition. (required)

  • code (str) – The code of the specified Check Definition. Together with the domain and scope this uniquely identifies the Check Definition. (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _request_timeout – Timeout setting. Do not use - use the opts parameter instead

  • opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

DeletedEntityResponse

delete_check_definition_with_http_info(scope, code, **kwargs)[source]

[EXPERIMENTAL] DeleteCheckDefinition: Deletes a particular Check Definition # noqa: E501

The deletion will take effect from the Check Definition deletion datetime. i.e. will no longer exist at any asAt datetime after the asAt datetime of deletion. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_check_definition_with_http_info(scope, code, async_req=True)
>>> result = thread.get()
Parameters:

  • scope (str) – The scope of the specified Check Definition. (required)

  • code (str) – The code of the specified Check Definition. Together with the domain and scope this uniquely identifies the Check Definition. (required)

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – Timeout setting. Do not use - use the opts parameter instead

  • opts (ConfigurationOptions, optional) – Configuration options for this request

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(DeletedEntityResponse, status_code(int), headers(HTTPHeaderDict))

delete_rules(scope, code, delete_data_quality_rule=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] DeleteRules: Delete rules on a particular Check Definition # noqa: E501

Delete rules for a given check definition. This will not affect any other rules that are not included in the request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_rules(scope, code, delete_data_quality_rule, async_req=True)
>>> result = thread.get()
Parameters:

  • scope (str) – The scope of the specified Check Definition. (required)

  • code (str) – The code of the specified Check Definition. Together with the domain and scope this uniquely identifies the Check Definition. (required)

  • delete_data_quality_rule (List[DeleteDataQualityRule]) – The request containing the rules to be deleted

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _request_timeout – Timeout setting. Do not use - use the opts parameter instead

  • opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

CheckDefinition

delete_rules_with_http_info(scope, code, delete_data_quality_rule=None, **kwargs)[source]

[EXPERIMENTAL] DeleteRules: Delete rules on a particular Check Definition # noqa: E501

Delete rules for a given check definition. This will not affect any other rules that are not included in the request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.delete_rules_with_http_info(scope, code, delete_data_quality_rule, async_req=True)
>>> result = thread.get()
Parameters:

  • scope (str) – The scope of the specified Check Definition. (required)

  • code (str) – The code of the specified Check Definition. Together with the domain and scope this uniquely identifies the Check Definition. (required)

  • delete_data_quality_rule (List[DeleteDataQualityRule]) – The request containing the rules to be deleted

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – Timeout setting. Do not use - use the opts parameter instead

  • opts (ConfigurationOptions, optional) – Configuration options for this request

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(CheckDefinition, status_code(int), headers(HTTPHeaderDict))

get_check_definition(scope, code, as_at=None, effective_at=None, property_keys=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] GetCheckDefinition: Get a single Check Definition by scope and code. # noqa: E501

Retrieves one Check Definition by scope and code. Check Definitions are mono-temporal. The EffectiveAt is only applied to Time-Variant Properties. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_check_definition(scope, code, as_at, effective_at, property_keys, async_req=True)
>>> result = thread.get()
Parameters:

  • scope (str) – The scope of the specified Check Definition. (required)

  • code (str) – The code of the specified Check Definition. Together with the scope this uniquely identifies the Check Definition. (required)

  • as_at (datetime) – The asAt datetime at which to retrieve the Check Definition definition. Defaults to return the latest version of the definition if not specified.

  • effective_at (str) – The effective datetime or cut label at which to retrieve the check definition properties. Defaults to the current LUSID system datetime if not specified.

  • property_keys (List[str]) – A list of property keys from the ‘CheckDefinition’ domain to decorate onto the Check Definition. These must have the format {domain}/{scope}/{code}, for example ‘CheckDefinition/system/Name’.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _request_timeout – Timeout setting. Do not use - use the opts parameter instead

  • opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

CheckDefinition

get_check_definition_with_http_info(scope, code, as_at=None, effective_at=None, property_keys=None, **kwargs)[source]

[EXPERIMENTAL] GetCheckDefinition: Get a single Check Definition by scope and code. # noqa: E501

Retrieves one Check Definition by scope and code. Check Definitions are mono-temporal. The EffectiveAt is only applied to Time-Variant Properties. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.get_check_definition_with_http_info(scope, code, as_at, effective_at, property_keys, async_req=True)
>>> result = thread.get()
Parameters:

  • scope (str) – The scope of the specified Check Definition. (required)

  • code (str) – The code of the specified Check Definition. Together with the scope this uniquely identifies the Check Definition. (required)

  • as_at (datetime) – The asAt datetime at which to retrieve the Check Definition definition. Defaults to return the latest version of the definition if not specified.

  • effective_at (str) – The effective datetime or cut label at which to retrieve the check definition properties. Defaults to the current LUSID system datetime if not specified.

  • property_keys (List[str]) – A list of property keys from the ‘CheckDefinition’ domain to decorate onto the Check Definition. These must have the format {domain}/{scope}/{code}, for example ‘CheckDefinition/system/Name’.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – Timeout setting. Do not use - use the opts parameter instead

  • opts (ConfigurationOptions, optional) – Configuration options for this request

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(CheckDefinition, status_code(int), headers(HTTPHeaderDict))

list_check_definitions(as_at=None, effective_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] ListCheckDefinitions: List Check Definitions # noqa: E501

List all the Check Definitions matching a particular criteria. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_check_definitions(as_at, effective_at, page, limit, filter, sort_by, property_keys, async_req=True)
>>> result = thread.get()
Parameters:

  • as_at (datetime) – The asAt datetime at which to list the Check Definitions. Defaults to returning the latest version of each Check Definition if not specified.

  • effective_at (str) – The effective datetime or cut label at which to list the Check Definitions. Note that Check Definitions are monotemporal, the effectiveAt is for Timevariant Properties on the Check Definition only. Defaults to the current LUSID system datetime if not specified.

  • page (str) – The pagination token to use to continue listing Check Definitions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.

  • limit (int) – When paginating, limit the results to this number. Defaults to 100 if not specified.

  • filter (str) – Expression to filter the results. For example, to filter on the displayName, specify “displayName eq ‘MyCheckDefinition’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.

  • sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”

  • property_keys (List[str]) – A list of property keys from the ‘CheckDefinition’ domain to decorate onto each Check Definition. These must take the format {domain}/{scope}/{code}, for example ‘CheckDefinition/Account/id’.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _request_timeout – Timeout setting. Do not use - use the opts parameter instead

  • opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

PagedResourceListOfCheckDefinition

list_check_definitions_with_http_info(as_at=None, effective_at=None, page=None, limit=None, filter=None, sort_by=None, property_keys=None, **kwargs)[source]

[EXPERIMENTAL] ListCheckDefinitions: List Check Definitions # noqa: E501

List all the Check Definitions matching a particular criteria. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.list_check_definitions_with_http_info(as_at, effective_at, page, limit, filter, sort_by, property_keys, async_req=True)
>>> result = thread.get()
Parameters:

  • as_at (datetime) – The asAt datetime at which to list the Check Definitions. Defaults to returning the latest version of each Check Definition if not specified.

  • effective_at (str) – The effective datetime or cut label at which to list the Check Definitions. Note that Check Definitions are monotemporal, the effectiveAt is for Timevariant Properties on the Check Definition only. Defaults to the current LUSID system datetime if not specified.

  • page (str) – The pagination token to use to continue listing Check Definitions; this value is returned from the previous call. If a pagination token is provided, the filter, effectiveAt and asAt fields must not have changed since the original request.

  • limit (int) – When paginating, limit the results to this number. Defaults to 100 if not specified.

  • filter (str) – Expression to filter the results. For example, to filter on the displayName, specify “displayName eq ‘MyCheckDefinition’”. For more information about filtering results, see https://support.lusid.com/knowledgebase/article/KA-01914.

  • sort_by (List[str]) – A list of field names or properties to sort by, each suffixed by “ ASC” or “ DESC”

  • property_keys (List[str]) – A list of property keys from the ‘CheckDefinition’ domain to decorate onto each Check Definition. These must take the format {domain}/{scope}/{code}, for example ‘CheckDefinition/Account/id’.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – Timeout setting. Do not use - use the opts parameter instead

  • opts (ConfigurationOptions, optional) – Configuration options for this request

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(PagedResourceListOfCheckDefinition, status_code(int), headers(HTTPHeaderDict))

run_check_definition(scope, code, run_check_request=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] RunCheckDefinition: Runs a Check Definition against given dataset. # noqa: E501

Runs a Check Definition against given dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.run_check_definition(scope, code, run_check_request, async_req=True)
>>> result = thread.get()
Parameters:

  • scope (str) – Scope of the CheckDefinition to run. (required)

  • code (str) – Code of the CheckDefinition to run. (required)

  • run_check_request (RunCheckRequest) – Run request defining what dataset to run against.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _request_timeout – Timeout setting. Do not use - use the opts parameter instead

  • opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

RunCheckResponse

run_check_definition_with_http_info(scope, code, run_check_request=None, **kwargs)[source]

[EXPERIMENTAL] RunCheckDefinition: Runs a Check Definition against given dataset. # noqa: E501

Runs a Check Definition against given dataset. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.run_check_definition_with_http_info(scope, code, run_check_request, async_req=True)
>>> result = thread.get()
Parameters:

  • scope (str) – Scope of the CheckDefinition to run. (required)

  • code (str) – Code of the CheckDefinition to run. (required)

  • run_check_request (RunCheckRequest) – Run request defining what dataset to run against.

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – Timeout setting. Do not use - use the opts parameter instead

  • opts (ConfigurationOptions, optional) – Configuration options for this request

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(RunCheckResponse, status_code(int), headers(HTTPHeaderDict))

update_check_definition(scope, code, update_check_definition_request=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] UpdateCheckDefinition: Update Check Definition defined by scope and code # noqa: E501

Overwrites an existing Check Definition Update request has the same required fields as Create apart from the id. Returns the updated Check Definition at the current effectiveAt. Note that Check Definitions are mono-temporal, however they can have Time-Variant Properties. Updated Properties will be returned at the latest AsAt and EffectiveAt # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.update_check_definition(scope, code, update_check_definition_request, async_req=True)
>>> result = thread.get()
Parameters:

  • scope (str) – The scope of the specified Check Definition. (required)

  • code (str) – The code of the specified Check Definition. Together with the domain and scope this uniquely identifies the Check Definition. (required)

  • update_check_definition_request (UpdateCheckDefinitionRequest) – The request containing the updated details of the Check Definition

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _request_timeout – Timeout setting. Do not use - use the opts parameter instead

  • opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

CheckDefinition

update_check_definition_with_http_info(scope, code, update_check_definition_request=None, **kwargs)[source]

[EXPERIMENTAL] UpdateCheckDefinition: Update Check Definition defined by scope and code # noqa: E501

Overwrites an existing Check Definition Update request has the same required fields as Create apart from the id. Returns the updated Check Definition at the current effectiveAt. Note that Check Definitions are mono-temporal, however they can have Time-Variant Properties. Updated Properties will be returned at the latest AsAt and EffectiveAt # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.update_check_definition_with_http_info(scope, code, update_check_definition_request, async_req=True)
>>> result = thread.get()
Parameters:

  • scope (str) – The scope of the specified Check Definition. (required)

  • code (str) – The code of the specified Check Definition. Together with the domain and scope this uniquely identifies the Check Definition. (required)

  • update_check_definition_request (UpdateCheckDefinitionRequest) – The request containing the updated details of the Check Definition

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – Timeout setting. Do not use - use the opts parameter instead

  • opts (ConfigurationOptions, optional) – Configuration options for this request

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(CheckDefinition, status_code(int), headers(HTTPHeaderDict))

upsert_rules(scope, code, upsert_data_quality_rule=None, async_req=None, **kwargs)[source]

[EXPERIMENTAL] UpsertRules: Upsert rules to a particular Check Definition # noqa: E501

Upsert rules for a given check definition. This will not affect any other rules that are not included in the request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.upsert_rules(scope, code, upsert_data_quality_rule, async_req=True)
>>> result = thread.get()
Parameters:

  • scope (str) – The scope of the specified Check Definition. (required)

  • code (str) – The code of the specified Check Definition. Together with the domain and scope this uniquely identifies the Check Definition. (required)

  • upsert_data_quality_rule (List[UpsertDataQualityRule]) – The request containing the rules to be upserted

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _request_timeout – Timeout setting. Do not use - use the opts parameter instead

  • opts (ConfigurationOptions, optional) – Configuration options for this request

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

CheckDefinition

upsert_rules_with_http_info(scope, code, upsert_data_quality_rule=None, **kwargs)[source]

[EXPERIMENTAL] UpsertRules: Upsert rules to a particular Check Definition # noqa: E501

Upsert rules for a given check definition. This will not affect any other rules that are not included in the request. # noqa: E501 This method makes a synchronous HTTP request by default. To make an asynchronous HTTP request, please pass async_req=True

>>> thread = api.upsert_rules_with_http_info(scope, code, upsert_data_quality_rule, async_req=True)
>>> result = thread.get()
Parameters:

  • scope (str) – The scope of the specified Check Definition. (required)

  • code (str) – The code of the specified Check Definition. Together with the domain and scope this uniquely identifies the Check Definition. (required)

  • upsert_data_quality_rule (List[UpsertDataQualityRule]) – The request containing the rules to be upserted

  • async_req (bool, optional) – Whether to execute the request asynchronously.

  • _preload_content (bool, optional) – if False, the ApiResponse.data will be set to none and raw_data will store the HTTP response body without reading/decoding. Default is True.

  • _return_http_data_only (bool, optional) – response data instead of ApiResponse object with status code, headers, etc

  • _request_timeout – Timeout setting. Do not use - use the opts parameter instead

  • opts (ConfigurationOptions, optional) – Configuration options for this request

  • _request_auth (dict, optional) – set to override the auth_settings for an a single request; this effectively ignores the authentication in the spec for a single request.

Returns:

Returns the result object. If the method is called asynchronously, returns the request thread.

Return type:

tuple(CheckDefinition, status_code(int), headers(HTTPHeaderDict))