sdk.lusid.api.staging_rule_set_api.StagingRuleSetApi
- class StagingRuleSetApi(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
[EXPERIMENTAL] CreateStagingRuleSet: Create a StagingRuleSet # noqa: E501
[EXPERIMENTAL] CreateStagingRuleSet: Create a StagingRuleSet # noqa: E501
[EXPERIMENTAL] DeleteStagingRuleSet: Delete a StagingRuleSet # noqa: E501
[EXPERIMENTAL] DeleteStagingRuleSet: Delete a StagingRuleSet # noqa: E501
[EXPERIMENTAL] GetStagingRuleSet: Get a StagingRuleSet # noqa: E501
[EXPERIMENTAL] GetStagingRuleSet: Get a StagingRuleSet # noqa: E501
[EXPERIMENTAL] ListStagingRuleSets: List StagingRuleSets # noqa: E501
[EXPERIMENTAL] ListStagingRuleSets: List StagingRuleSets # noqa: E501
[EXPERIMENTAL] UpdateStagingRuleSet: Update a StagingRuleSet # noqa: E501
[EXPERIMENTAL] UpdateStagingRuleSet: Update a StagingRuleSet # noqa: E501
- create_staging_rule_set(entity_type, create_staging_rule_set_request, async_req=None, **kwargs)[source]
[EXPERIMENTAL] CreateStagingRuleSet: Create a StagingRuleSet # noqa: E501
Create a new staging rule set. # 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_staging_rule_set(entity_type, create_staging_rule_set_request, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The entity type for which to create the staging rule set. (required)
create_staging_rule_set_request (CreateStagingRuleSetRequest) – Request to create a staging rule set. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- create_staging_rule_set_with_http_info(entity_type, create_staging_rule_set_request, **kwargs)[source]
[EXPERIMENTAL] CreateStagingRuleSet: Create a StagingRuleSet # noqa: E501
Create a new staging rule set. # 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_staging_rule_set_with_http_info(entity_type, create_staging_rule_set_request, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The entity type for which to create the staging rule set. (required)
create_staging_rule_set_request (CreateStagingRuleSetRequest) – Request to create a staging rule set. (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 for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_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(StagingRuleSet, status_code(int), headers(HTTPHeaderDict))
- delete_staging_rule_set(entity_type, async_req=None, **kwargs)[source]
[EXPERIMENTAL] DeleteStagingRuleSet: Delete a StagingRuleSet # noqa: E501
Delete a staging rule set of a specific entity type. Deletion will be valid from the staging rule set’s creation datetime. This means that the staging rule set will no longer exist at any effective datetime from 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_staging_rule_set(entity_type, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The entity type for which to delete the staging rule set. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- delete_staging_rule_set_with_http_info(entity_type, **kwargs)[source]
[EXPERIMENTAL] DeleteStagingRuleSet: Delete a StagingRuleSet # noqa: E501
Delete a staging rule set of a specific entity type. Deletion will be valid from the staging rule set’s creation datetime. This means that the staging rule set will no longer exist at any effective datetime from 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_staging_rule_set_with_http_info(entity_type, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The entity type for which to delete the staging rule set. (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 for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_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))
- get_staging_rule_set(entity_type, as_at=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] GetStagingRuleSet: Get a StagingRuleSet # noqa: E501
Get the staging rule set for the given entity type at the specific asAt time. # 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_staging_rule_set(entity_type, as_at, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The entity type for which to retrieve the staging rule set. (required)
as_at (datetime) – The asAt datetime at which to retrieve the staging rule set. Defaults to return the latest version of the staging rule set if not specified.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- get_staging_rule_set_with_http_info(entity_type, as_at=None, **kwargs)[source]
[EXPERIMENTAL] GetStagingRuleSet: Get a StagingRuleSet # noqa: E501
Get the staging rule set for the given entity type at the specific asAt time. # 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_staging_rule_set_with_http_info(entity_type, as_at, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The entity type for which to retrieve the staging rule set. (required)
as_at (datetime) – The asAt datetime at which to retrieve the staging rule set. Defaults to return the latest version of the staging rule set if not specified.
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 for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_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(StagingRuleSet, status_code(int), headers(HTTPHeaderDict))
- list_staging_rule_sets(as_at=None, page=None, sort_by=None, limit=None, filter=None, async_req=None, **kwargs)[source]
[EXPERIMENTAL] ListStagingRuleSets: List StagingRuleSets # noqa: E501
List all the staging rule sets matching 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_staging_rule_sets(as_at, page, sort_by, limit, filter, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to retrieve the staging rule sets. Defaults to return the latest version of the staging rule sets if not specified.
page (str) – The pagination token to use to continue listing staging rule sets from a previous call to list staging rule sets. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”
limit (int) – When paginating, limit the number of returned results to this many.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- list_staging_rule_sets_with_http_info(as_at=None, page=None, sort_by=None, limit=None, filter=None, **kwargs)[source]
[EXPERIMENTAL] ListStagingRuleSets: List StagingRuleSets # noqa: E501
List all the staging rule sets matching 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_staging_rule_sets_with_http_info(as_at, page, sort_by, limit, filter, async_req=True) >>> result = thread.get()
- Parameters:
as_at (datetime) – The asAt datetime at which to retrieve the staging rule sets. Defaults to return the latest version of the staging rule sets if not specified.
page (str) – The pagination token to use to continue listing staging rule sets from a previous call to list staging rule sets. This value is returned from the previous call. If a pagination token is provided the sortBy, filter, effectiveAt, and asAt fields must not have changed since the original request.
sort_by (List[str]) – A list of field names to sort by, each suffixed by “ ASC” or “ DESC”
limit (int) – When paginating, limit the number of returned results to this many.
filter (str) – Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid.
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 for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_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(PagedResourceListOfStagingRuleSet, status_code(int), headers(HTTPHeaderDict))
- update_staging_rule_set(entity_type, update_staging_rule_set_request, async_req=None, **kwargs)[source]
[EXPERIMENTAL] UpdateStagingRuleSet: Update a StagingRuleSet # noqa: E501
Update an existing staging rule set. # 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_staging_rule_set(entity_type, update_staging_rule_set_request, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The entity type for which to update the staging rule set. (required)
update_staging_rule_set_request (UpdateStagingRuleSetRequest) – Request to update a staging rule set. (required)
async_req (bool, optional) – Whether to execute the request asynchronously.
_request_timeout – timeout setting for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
- Returns:
Returns the result object. If the method is called asynchronously, returns the request thread.
- Return type:
- update_staging_rule_set_with_http_info(entity_type, update_staging_rule_set_request, **kwargs)[source]
[EXPERIMENTAL] UpdateStagingRuleSet: Update a StagingRuleSet # noqa: E501
Update an existing staging rule set. # 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_staging_rule_set_with_http_info(entity_type, update_staging_rule_set_request, async_req=True) >>> result = thread.get()
- Parameters:
entity_type (str) – The entity type for which to update the staging rule set. (required)
update_staging_rule_set_request (UpdateStagingRuleSetRequest) – Request to update a staging rule set. (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 for this request. If one number provided, it will be total request timeout. It can also be a pair (tuple) of (connection, read) timeouts.
_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(StagingRuleSet, status_code(int), headers(HTTPHeaderDict))