Represents a collection of functions to interact with the API endpoints More...

Inheritance diagram for Lusid.Sdk.Api.IStagingRuleSetApiAsync:

[legend]

Public Member Functions
System.Threading.Tasks.Task< StagingRuleSet >	CreateStagingRuleSetAsync (string entityType, CreateStagingRuleSetRequest createStagingRuleSetRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] CreateStagingRuleSet: Create a StagingRuleSet More...

System.Threading.Tasks.Task< ApiResponse< StagingRuleSet > >	CreateStagingRuleSetWithHttpInfoAsync (string entityType, CreateStagingRuleSetRequest createStagingRuleSetRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] CreateStagingRuleSet: Create a StagingRuleSet More...

System.Threading.Tasks.Task< DeletedEntityResponse >	DeleteStagingRuleSetAsync (string entityType, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] DeleteStagingRuleSet: Delete a StagingRuleSet More...

System.Threading.Tasks.Task< ApiResponse< DeletedEntityResponse > >	DeleteStagingRuleSetWithHttpInfoAsync (string entityType, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] DeleteStagingRuleSet: Delete a StagingRuleSet More...

System.Threading.Tasks.Task< StagingRuleSet >	GetStagingRuleSetAsync (string entityType, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetStagingRuleSet: Get a StagingRuleSet More...

System.Threading.Tasks.Task< ApiResponse< StagingRuleSet > >	GetStagingRuleSetWithHttpInfoAsync (string entityType, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] GetStagingRuleSet: Get a StagingRuleSet More...

System.Threading.Tasks.Task< PagedResourceListOfStagingRuleSet >	ListStagingRuleSetsAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] ListStagingRuleSets: List StagingRuleSets More...

System.Threading.Tasks.Task< ApiResponse< PagedResourceListOfStagingRuleSet > >	ListStagingRuleSetsWithHttpInfoAsync (DateTimeOffset? asAt=default(DateTimeOffset?), string? page=default(string?), List< string >? sortBy=default(List< string >?), int? limit=default(int?), string? filter=default(string?), int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] ListStagingRuleSets: List StagingRuleSets More...

System.Threading.Tasks.Task< StagingRuleSet >	UpdateStagingRuleSetAsync (string entityType, UpdateStagingRuleSetRequest updateStagingRuleSetRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] UpdateStagingRuleSet: Update a StagingRuleSet More...

System.Threading.Tasks.Task< ApiResponse< StagingRuleSet > >	UpdateStagingRuleSetWithHttpInfoAsync (string entityType, UpdateStagingRuleSetRequest updateStagingRuleSetRequest, int operationIndex=0, System.Threading.CancellationToken cancellationToken=default(System.Threading.CancellationToken))
	[EXPERIMENTAL] UpdateStagingRuleSet: Update a StagingRuleSet More...

Public Member Functions inherited from Lusid.Sdk.Client.IApiAccessor
string	GetBasePath ()
	Gets the base path of the API client. More...

Additional Inherited Members
Properties inherited from Lusid.Sdk.Client.IApiAccessor
IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

ExceptionFactory	ExceptionFactory `[get, set]`
	Provides a factory method hook for the creation of exceptions. More...

Detailed Description

Represents a collection of functions to interact with the API endpoints

Member Function Documentation

◆ CreateStagingRuleSetAsync()

System.Threading.Tasks.Task<StagingRuleSet> Lusid.Sdk.Api.IStagingRuleSetApiAsync.CreateStagingRuleSetAsync	(	string	entityType,
		CreateStagingRuleSetRequest	createStagingRuleSetRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] CreateStagingRuleSet: Create a StagingRuleSet

Create a new staging rule set.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

entityType	The entity type for which to create the staging rule set.
createStagingRuleSetRequest	Request to create a staging rule set.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of StagingRuleSet

Implemented in Lusid.Sdk.Api.StagingRuleSetApi.

◆ CreateStagingRuleSetWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<StagingRuleSet> > Lusid.Sdk.Api.IStagingRuleSetApiAsync.CreateStagingRuleSetWithHttpInfoAsync	(	string	entityType,
		CreateStagingRuleSetRequest	createStagingRuleSetRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] CreateStagingRuleSet: Create a StagingRuleSet

Create a new staging rule set.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

entityType	The entity type for which to create the staging rule set.
createStagingRuleSetRequest	Request to create a staging rule set.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (StagingRuleSet)

Implemented in Lusid.Sdk.Api.StagingRuleSetApi.

◆ DeleteStagingRuleSetAsync()

System.Threading.Tasks.Task<DeletedEntityResponse> Lusid.Sdk.Api.IStagingRuleSetApiAsync.DeleteStagingRuleSetAsync	(	string	entityType,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] DeleteStagingRuleSet: Delete a StagingRuleSet

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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

entityType	The entity type for which to delete the staging rule set.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of DeletedEntityResponse

Implemented in Lusid.Sdk.Api.StagingRuleSetApi.

◆ DeleteStagingRuleSetWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<DeletedEntityResponse> > Lusid.Sdk.Api.IStagingRuleSetApiAsync.DeleteStagingRuleSetWithHttpInfoAsync	(	string	entityType,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] DeleteStagingRuleSet: Delete a StagingRuleSet

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.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

entityType	The entity type for which to delete the staging rule set.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (DeletedEntityResponse)

Implemented in Lusid.Sdk.Api.StagingRuleSetApi.

◆ GetStagingRuleSetAsync()

System.Threading.Tasks.Task<StagingRuleSet> Lusid.Sdk.Api.IStagingRuleSetApiAsync.GetStagingRuleSetAsync	(	string	entityType,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetStagingRuleSet: Get a StagingRuleSet

Get the staging rule set for the given entity type at the specific asAt time.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

entityType	The entity type for which to retrieve the staging rule set.
asAt	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. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of StagingRuleSet

Implemented in Lusid.Sdk.Api.StagingRuleSetApi.

◆ GetStagingRuleSetWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<StagingRuleSet> > Lusid.Sdk.Api.IStagingRuleSetApiAsync.GetStagingRuleSetWithHttpInfoAsync	(	string	entityType,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] GetStagingRuleSet: Get a StagingRuleSet

Get the staging rule set for the given entity type at the specific asAt time.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

entityType	The entity type for which to retrieve the staging rule set.
asAt	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. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (StagingRuleSet)

Implemented in Lusid.Sdk.Api.StagingRuleSetApi.

◆ ListStagingRuleSetsAsync()

System.Threading.Tasks.Task<PagedResourceListOfStagingRuleSet> Lusid.Sdk.Api.IStagingRuleSetApiAsync.ListStagingRuleSetsAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] ListStagingRuleSets: List StagingRuleSets

List all the staging rule sets matching particular criteria.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	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. (optional)
page	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. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of PagedResourceListOfStagingRuleSet

Implemented in Lusid.Sdk.Api.StagingRuleSetApi.

◆ ListStagingRuleSetsWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<PagedResourceListOfStagingRuleSet> > Lusid.Sdk.Api.IStagingRuleSetApiAsync.ListStagingRuleSetsWithHttpInfoAsync	(	DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		string?	page = `default(string?)`,
		List< string >?	sortBy = `default(List< string >?)`,
		int?	limit = `default(int?)`,
		string?	filter = `default(string?)`,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] ListStagingRuleSets: List StagingRuleSets

List all the staging rule sets matching particular criteria.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

asAt	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. (optional)
page	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. (optional)
sortBy	A list of field names to sort by, each suffixed by " ASC" or " DESC" (optional)
limit	When paginating, limit the number of returned results to this many. (optional)
filter	Expression to filter the result set. Read more about filtering results from LUSID here: https://support.lusid.com/filtering-results-from-lusid. (optional)
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (PagedResourceListOfStagingRuleSet)

Implemented in Lusid.Sdk.Api.StagingRuleSetApi.

◆ UpdateStagingRuleSetAsync()

System.Threading.Tasks.Task<StagingRuleSet> Lusid.Sdk.Api.IStagingRuleSetApiAsync.UpdateStagingRuleSetAsync	(	string	entityType,
		UpdateStagingRuleSetRequest	updateStagingRuleSetRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] UpdateStagingRuleSet: Update a StagingRuleSet

Update an existing staging rule set.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

entityType	The entity type for which to update the staging rule set.
updateStagingRuleSetRequest	Request to update a staging rule set.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of StagingRuleSet

Implemented in Lusid.Sdk.Api.StagingRuleSetApi.

◆ UpdateStagingRuleSetWithHttpInfoAsync()

System.Threading.Tasks.Task<ApiResponse<StagingRuleSet> > Lusid.Sdk.Api.IStagingRuleSetApiAsync.UpdateStagingRuleSetWithHttpInfoAsync	(	string	entityType,
		UpdateStagingRuleSetRequest	updateStagingRuleSetRequest,
		int	operationIndex = `0`,
		System.Threading.CancellationToken	cancellationToken = `default(System.Threading.CancellationToken)`
	)

[EXPERIMENTAL] UpdateStagingRuleSet: Update a StagingRuleSet

Update an existing staging rule set.

Exceptions

Lusid.Sdk.Client.ApiException Thrown when fails to make API call

Parameters

entityType	The entity type for which to update the staging rule set.
updateStagingRuleSetRequest	Request to update a staging rule set.
operationIndex	Index associated with the operation.
cancellationToken	Cancellation Token to cancel the request.

Returns: Task of ApiResponse (StagingRuleSet)

Implemented in Lusid.Sdk.Api.StagingRuleSetApi.

The documentation for this interface was generated from the following file:

/home/docs/checkouts/readthedocs.org/user_builds/lusid-sdk-csharp/checkouts/latest/sdk/Lusid.Sdk/Api/StagingRuleSetApi.cs

Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ CreateStagingRuleSetAsync()

◆ CreateStagingRuleSetWithHttpInfoAsync()

◆ DeleteStagingRuleSetAsync()

◆ DeleteStagingRuleSetWithHttpInfoAsync()

◆ GetStagingRuleSetAsync()

◆ GetStagingRuleSetWithHttpInfoAsync()

◆ ListStagingRuleSetsAsync()

◆ ListStagingRuleSetsWithHttpInfoAsync()

◆ UpdateStagingRuleSetAsync()

◆ UpdateStagingRuleSetWithHttpInfoAsync()