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

Inheritance diagram for Lusid.Sdk.Api.StagingRuleSetApi:

[legend]

Public Member Functions
	StagingRuleSetApi ()
	Initializes a new instance of the StagingRuleSetApi class. More...

	StagingRuleSetApi (string basePath)
	Initializes a new instance of the StagingRuleSetApi class. More...

	StagingRuleSetApi (Lusid.Sdk.Client.Configuration configuration)
	Initializes a new instance of the StagingRuleSetApi class using Configuration object More...

	StagingRuleSetApi (Lusid.Sdk.Client.ISynchronousClient client, Lusid.Sdk.Client.IAsynchronousClient asyncClient, Lusid.Sdk.Client.IReadableConfiguration configuration)
	Initializes a new instance of the StagingRuleSetApi class using a Configuration object and client instance. More...

string	GetBasePath ()
	Gets the base path of the API client. More...

StagingRuleSet	CreateStagingRuleSet (string entityType, CreateStagingRuleSetRequest createStagingRuleSetRequest, int operationIndex=0)
	[EXPERIMENTAL] CreateStagingRuleSet: Create a StagingRuleSet Create a new staging rule set. More...

Lusid.Sdk.Client.ApiResponse< StagingRuleSet >	CreateStagingRuleSetWithHttpInfo (string entityType, CreateStagingRuleSetRequest createStagingRuleSetRequest, int operationIndex=0)
	[EXPERIMENTAL] CreateStagingRuleSet: Create a StagingRuleSet Create a new staging rule set. More...

async 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 Create a new staging rule set. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< StagingRuleSet > >	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. More...

DeletedEntityResponse	DeleteStagingRuleSet (string entityType, int operationIndex=0)
	[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. More...

Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse >	DeleteStagingRuleSetWithHttpInfo (string entityType, int operationIndex=0)
	[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. More...

async System.Threading.Tasks.Task< DeletedEntityResponse >	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. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< DeletedEntityResponse > >	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. More...

StagingRuleSet	GetStagingRuleSet (string entityType, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EXPERIMENTAL] GetStagingRuleSet: Get a StagingRuleSet Get the staging rule set for the given entity type at the specific asAt time. More...

Lusid.Sdk.Client.ApiResponse< StagingRuleSet >	GetStagingRuleSetWithHttpInfo (string entityType, DateTimeOffset? asAt=default(DateTimeOffset?), int operationIndex=0)
	[EXPERIMENTAL] GetStagingRuleSet: Get a StagingRuleSet Get the staging rule set for the given entity type at the specific asAt time. More...

async 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 Get the staging rule set for the given entity type at the specific asAt time. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 Get the staging rule set for the given entity type at the specific asAt time. More...

PagedResourceListOfStagingRuleSet	ListStagingRuleSets (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)
	[EXPERIMENTAL] ListStagingRuleSets: List StagingRuleSets List all the staging rule sets matching particular criteria. More...

Lusid.Sdk.Client.ApiResponse< PagedResourceListOfStagingRuleSet >	ListStagingRuleSetsWithHttpInfo (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)
	[EXPERIMENTAL] ListStagingRuleSets: List StagingRuleSets List all the staging rule sets matching particular criteria. More...

async 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 List all the staging rule sets matching particular criteria. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.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 List all the staging rule sets matching particular criteria. More...

StagingRuleSet	UpdateStagingRuleSet (string entityType, UpdateStagingRuleSetRequest updateStagingRuleSetRequest, int operationIndex=0)
	[EXPERIMENTAL] UpdateStagingRuleSet: Update a StagingRuleSet Update an existing staging rule set. More...

Lusid.Sdk.Client.ApiResponse< StagingRuleSet >	UpdateStagingRuleSetWithHttpInfo (string entityType, UpdateStagingRuleSetRequest updateStagingRuleSetRequest, int operationIndex=0)
	[EXPERIMENTAL] UpdateStagingRuleSet: Update a StagingRuleSet Update an existing staging rule set. More...

async 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 Update an existing staging rule set. More...

async System.Threading.Tasks.Task< Lusid.Sdk.Client.ApiResponse< StagingRuleSet > >	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. More...

Properties
Lusid.Sdk.Client.IAsynchronousClient	AsynchronousClient `[get, set]`
	The client for accessing this underlying API asynchronously. More...

Lusid.Sdk.Client.ISynchronousClient	Client `[get, set]`
	The client for accessing this underlying API synchronously. More...

Lusid.Sdk.Client.IReadableConfiguration	Configuration `[get, set]`
	Gets or sets the configuration object More...

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

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

Constructor & Destructor Documentation

◆ StagingRuleSetApi() [1/4]

Lusid.Sdk.Api.StagingRuleSetApi.StagingRuleSetApi ( )

inline

Initializes a new instance of the StagingRuleSetApi class.

Returns

◆ StagingRuleSetApi() [2/4]

Lusid.Sdk.Api.StagingRuleSetApi.StagingRuleSetApi ( string basePath )

inline

Initializes a new instance of the StagingRuleSetApi class.

Returns

◆ StagingRuleSetApi() [3/4]

Lusid.Sdk.Api.StagingRuleSetApi.StagingRuleSetApi ( Lusid.Sdk.Client.Configuration configuration )

inline

Initializes a new instance of the StagingRuleSetApi class using Configuration object

Parameters

configuration An instance of Configuration

Returns

◆ StagingRuleSetApi() [4/4]

Lusid.Sdk.Api.StagingRuleSetApi.StagingRuleSetApi	(	Lusid.Sdk.Client.ISynchronousClient	client,
		Lusid.Sdk.Client.IAsynchronousClient	asyncClient,
		Lusid.Sdk.Client.IReadableConfiguration	configuration
	)

inline

Initializes a new instance of the StagingRuleSetApi class using a Configuration object and client instance.

Parameters

client	The client interface for synchronous API access.
asyncClient	The client interface for asynchronous API access.
configuration	The configuration object.

Member Function Documentation

◆ CreateStagingRuleSet()

StagingRuleSet Lusid.Sdk.Api.StagingRuleSetApi.CreateStagingRuleSet	(	string	entityType,
		CreateStagingRuleSetRequest	createStagingRuleSetRequest,
		int	operationIndex = `0`
	)

inline

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

Returns: StagingRuleSet

Implements Lusid.Sdk.Api.IStagingRuleSetApiSync.

◆ CreateStagingRuleSetAsync()

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

inline

[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

Implements Lusid.Sdk.Api.IStagingRuleSetApiAsync.

◆ CreateStagingRuleSetWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<StagingRuleSet> Lusid.Sdk.Api.StagingRuleSetApi.CreateStagingRuleSetWithHttpInfo	(	string	entityType,
		CreateStagingRuleSetRequest	createStagingRuleSetRequest,
		int	operationIndex = `0`
	)

inline

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

Returns: ApiResponse of StagingRuleSet

Implements Lusid.Sdk.Api.IStagingRuleSetApiSync.

◆ CreateStagingRuleSetWithHttpInfoAsync()

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

inline

[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)

Implements Lusid.Sdk.Api.IStagingRuleSetApiAsync.

◆ DeleteStagingRuleSet()

DeletedEntityResponse Lusid.Sdk.Api.StagingRuleSetApi.DeleteStagingRuleSet	(	string	entityType,
		int	operationIndex = `0`
	)

inline

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

Returns: DeletedEntityResponse

Implements Lusid.Sdk.Api.IStagingRuleSetApiSync.

◆ DeleteStagingRuleSetAsync()

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

inline

[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

Implements Lusid.Sdk.Api.IStagingRuleSetApiAsync.

◆ DeleteStagingRuleSetWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<DeletedEntityResponse> Lusid.Sdk.Api.StagingRuleSetApi.DeleteStagingRuleSetWithHttpInfo	(	string	entityType,
		int	operationIndex = `0`
	)

inline

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

Returns: ApiResponse of DeletedEntityResponse

Implements Lusid.Sdk.Api.IStagingRuleSetApiSync.

◆ DeleteStagingRuleSetWithHttpInfoAsync()

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

inline

[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)

Implements Lusid.Sdk.Api.IStagingRuleSetApiAsync.

◆ GetBasePath()

string Lusid.Sdk.Api.StagingRuleSetApi.GetBasePath ( )

inline

Gets the base path of the API client.

The base path

Implements Lusid.Sdk.Client.IApiAccessor.

◆ GetStagingRuleSet()

StagingRuleSet Lusid.Sdk.Api.StagingRuleSetApi.GetStagingRuleSet	(	string	entityType,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

inline

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

Returns: StagingRuleSet

Implements Lusid.Sdk.Api.IStagingRuleSetApiSync.

◆ GetStagingRuleSetAsync()

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

inline

[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

Implements Lusid.Sdk.Api.IStagingRuleSetApiAsync.

◆ GetStagingRuleSetWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<StagingRuleSet> Lusid.Sdk.Api.StagingRuleSetApi.GetStagingRuleSetWithHttpInfo	(	string	entityType,
		DateTimeOffset?	asAt = `default(DateTimeOffset?)`,
		int	operationIndex = `0`
	)

inline

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

Returns: ApiResponse of StagingRuleSet

Implements Lusid.Sdk.Api.IStagingRuleSetApiSync.

◆ GetStagingRuleSetWithHttpInfoAsync()

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

inline

[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)

Implements Lusid.Sdk.Api.IStagingRuleSetApiAsync.

◆ ListStagingRuleSets()

PagedResourceListOfStagingRuleSet Lusid.Sdk.Api.StagingRuleSetApi.ListStagingRuleSets	(	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`
	)

inline

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

Returns: PagedResourceListOfStagingRuleSet

Implements Lusid.Sdk.Api.IStagingRuleSetApiSync.

◆ ListStagingRuleSetsAsync()

async System.Threading.Tasks.Task<PagedResourceListOfStagingRuleSet> Lusid.Sdk.Api.StagingRuleSetApi.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)`
	)

inline

[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

Implements Lusid.Sdk.Api.IStagingRuleSetApiAsync.

◆ ListStagingRuleSetsWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<PagedResourceListOfStagingRuleSet> Lusid.Sdk.Api.StagingRuleSetApi.ListStagingRuleSetsWithHttpInfo	(	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`
	)

inline

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

Returns: ApiResponse of PagedResourceListOfStagingRuleSet

Implements Lusid.Sdk.Api.IStagingRuleSetApiSync.

◆ ListStagingRuleSetsWithHttpInfoAsync()

async System.Threading.Tasks.Task<Lusid.Sdk.Client.ApiResponse<PagedResourceListOfStagingRuleSet> > Lusid.Sdk.Api.StagingRuleSetApi.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)`
	)

inline

[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)

Implements Lusid.Sdk.Api.IStagingRuleSetApiAsync.

◆ UpdateStagingRuleSet()

StagingRuleSet Lusid.Sdk.Api.StagingRuleSetApi.UpdateStagingRuleSet	(	string	entityType,
		UpdateStagingRuleSetRequest	updateStagingRuleSetRequest,
		int	operationIndex = `0`
	)

inline

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

Returns: StagingRuleSet

Implements Lusid.Sdk.Api.IStagingRuleSetApiSync.

◆ UpdateStagingRuleSetAsync()

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

inline

[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

Implements Lusid.Sdk.Api.IStagingRuleSetApiAsync.

◆ UpdateStagingRuleSetWithHttpInfo()

Lusid.Sdk.Client.ApiResponse<StagingRuleSet> Lusid.Sdk.Api.StagingRuleSetApi.UpdateStagingRuleSetWithHttpInfo	(	string	entityType,
		UpdateStagingRuleSetRequest	updateStagingRuleSetRequest,
		int	operationIndex = `0`
	)

inline

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

Returns: ApiResponse of StagingRuleSet

Implements Lusid.Sdk.Api.IStagingRuleSetApiSync.

◆ UpdateStagingRuleSetWithHttpInfoAsync()

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

inline

[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)

Implements Lusid.Sdk.Api.IStagingRuleSetApiAsync.

Property Documentation

◆ AsynchronousClient

Lusid.Sdk.Client.IAsynchronousClient Lusid.Sdk.Api.StagingRuleSetApi.AsynchronousClient

getset

The client for accessing this underlying API asynchronously.

◆ Client

Lusid.Sdk.Client.ISynchronousClient Lusid.Sdk.Api.StagingRuleSetApi.Client

getset

The client for accessing this underlying API synchronously.

◆ Configuration

Lusid.Sdk.Client.IReadableConfiguration Lusid.Sdk.Api.StagingRuleSetApi.Configuration

getset

Gets or sets the configuration object

An instance of the Configuration

◆ ExceptionFactory

Lusid.Sdk.Client.ExceptionFactory Lusid.Sdk.Api.StagingRuleSetApi.ExceptionFactory

getset

Provides a factory method hook for the creation of exceptions.

The documentation for this class 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

Properties

Detailed Description

Constructor & Destructor Documentation

◆ StagingRuleSetApi() [1/4]

◆ StagingRuleSetApi() [2/4]

◆ StagingRuleSetApi() [3/4]

◆ StagingRuleSetApi() [4/4]

Member Function Documentation

◆ CreateStagingRuleSet()

◆ CreateStagingRuleSetAsync()

◆ CreateStagingRuleSetWithHttpInfo()

◆ CreateStagingRuleSetWithHttpInfoAsync()

◆ DeleteStagingRuleSet()

◆ DeleteStagingRuleSetAsync()

◆ DeleteStagingRuleSetWithHttpInfo()

◆ DeleteStagingRuleSetWithHttpInfoAsync()

◆ GetBasePath()

◆ GetStagingRuleSet()

◆ GetStagingRuleSetAsync()

◆ GetStagingRuleSetWithHttpInfo()

◆ GetStagingRuleSetWithHttpInfoAsync()

◆ ListStagingRuleSets()

◆ ListStagingRuleSetsAsync()

◆ ListStagingRuleSetsWithHttpInfo()

◆ ListStagingRuleSetsWithHttpInfoAsync()

◆ UpdateStagingRuleSet()

◆ UpdateStagingRuleSetAsync()

◆ UpdateStagingRuleSetWithHttpInfo()

◆ UpdateStagingRuleSetWithHttpInfoAsync()

Property Documentation

◆ AsynchronousClient

◆ Client

◆ Configuration

◆ ExceptionFactory