Interface IXperiflowGeneratorsClient

Namespace: Workspace.XBR.Xperiflow.Core.RestApi.Generators

Assembly: Xperiflow.dll

Declaration

public interface IXperiflowGeneratorsClient

Methods

GetGeneratorPackagesResourceAsync(XperiflowSessionInfo, IEnumerable<string>?, string?, int?, int?, string?, MemoizedCacheInfo?, int[], CancellationToken)

GeneratorPackagesResource

Declaration

Task<GetGeneratorPackagesResourceResponseContext> GetGeneratorPackagesResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, IEnumerable<string>? fields = null, string? filter = null, int? page = null, int? records_per_page = null, string? order_bys = null, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve all available event generator packages with their names and descriptions with pagination, filtering, and sorting support.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Generators.GetGeneratorPackagesResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.Collections.Generic.IEnumerable<System.String>	fields	A json list of column names to return in the request.
System.String	filter	A json dictionary of a filter statement.
System.Nullable<System.Int32>	page	The page to return if using pagination.
System.Nullable<System.Int32>	records_per_page	The amount of records per page to return if using pagination.
System.String	order_bys	A json dictionary containing an order by statement.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Int32[]	mutedStatusCodes
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostGeneratorPackagesResourceAsync(XperiflowSessionInfo, BodyGeneratorPackagesContext, MemoizedCacheInfo?, int[], CancellationToken)

GeneratorPackagesResource

Declaration

Task<NullDataXperiflowResponseContext> PostGeneratorPackagesResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, BodyGeneratorPackagesContext body, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Create a new event generator package with a specified name and description.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Generators.NullDataXperiflowResponseContext >

created

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
Workspace.XBR.Xperiflow.Core.RestApi.Generators.BodyGeneratorPackagesContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Int32[]	mutedStatusCodes
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetGeneratorPackageGeneratorsResourceAsync(XperiflowSessionInfo, string, MemoizedCacheInfo?, int[], CancellationToken)

GeneratorPackageGeneratorsResource

Declaration

Task<GetGeneratorPackageGeneratorsResourceResponseContext> GetGeneratorPackageGeneratorsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string package_name, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve all generators configured within a generator package including their initialization parameters, fit parameters, and feature selection settings.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Generators.GetGeneratorPackageGeneratorsResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.String	package_name
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Int32[]	mutedStatusCodes
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PutGeneratorPackageGeneratorsResourceAsync(XperiflowSessionInfo, IntItemsIdentifierContext, string, MemoizedCacheInfo?, int[], CancellationToken)

GeneratorPackageGeneratorsResource

Declaration

Task<NullDataXperiflowResponseContext> PutGeneratorPackageGeneratorsResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, IntItemsIdentifierContext body, string package_name, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Update generator assignments for a package by providing a list of generator IDs. Replaces all existing generator assignments with the provided list.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Generators.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
Workspace.XBR.Xperiflow.Core.RestApi.Generators.IntItemsIdentifierContext	body
System.String	package_name
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Int32[]	mutedStatusCodes
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PutGeneratorPackageResourceAsync(XperiflowSessionInfo, PutBodyGeneratorPackageContext, string, MemoizedCacheInfo?, int[], CancellationToken)

GeneratorPackageResource

Declaration

Task<NullDataXperiflowResponseContext> PutGeneratorPackageResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, PutBodyGeneratorPackageContext body, string package_name, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Update the description of an event generator package.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Generators.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
Workspace.XBR.Xperiflow.Core.RestApi.Generators.PutBodyGeneratorPackageContext	body
System.String	package_name
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Int32[]	mutedStatusCodes
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

DeleteGeneratorPackageResourceAsync(XperiflowSessionInfo, string, MemoizedCacheInfo?, int[], CancellationToken)

GeneratorPackageResource

Declaration

Task<NullDataXperiflowResponseContext> DeleteGeneratorPackageResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string package_name, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Delete an event generator package and its associated configurations.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Generators.NullDataXperiflowResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.String	package_name
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Int32[]	mutedStatusCodes
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostGeneratorPBMResourceAsync(XperiflowSessionInfo, BodyGeneratorPbmDto, MemoizedCacheInfo?, int[], CancellationToken)

GeneratorPBMResource

Declaration

Task<PostResponseGeneratorPbmResource> PostGeneratorPBMResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, BodyGeneratorPbmDto body, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Initiate a new workflow for creating or managing event generators.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Generators.PostResponseGeneratorPbmResource >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
Workspace.XBR.Xperiflow.Core.RestApi.Generators.BodyGeneratorPbmDto	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Int32[]	mutedStatusCodes
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

PostOccurrencesExpansionResourceAsync(XperiflowSessionInfo, PostBodyOccurrencesExpansionContext, MemoizedCacheInfo?, int[], CancellationToken)

OccurrencesExpansionResource

Declaration

Task<PostResponseOccurrencesExpansionContext> PostOccurrencesExpansionResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, PostBodyOccurrencesExpansionContext body, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Expand generator occurrence expressions into a list of specific dates for event and feature generation scheduling.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Generators.PostResponseOccurrencesExpansionContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
Workspace.XBR.Xperiflow.Core.RestApi.Generators.PostBodyOccurrencesExpansionContext	body
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Int32[]	mutedStatusCodes
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.

GetGeneratorCollectionResourceAsync(XperiflowSessionInfo, string?, MemoizedCacheInfo?, int[], CancellationToken)

GeneratorCollectionResource

Declaration

Task<GetGeneratorCollectionResourceResponseContext> GetGeneratorCollectionResourceAsync(XperiflowSessionInfo x_OS_SessionInfo, string? query = null, MemoizedCacheInfo? cacheInfo = null, int[] mutedStatusCodes = null, CancellationToken cancellationToken = default)

Remarks

Retrieve metadata for all available feature generators including their names, parent classes, and attributes. Supports filtering via Pinq query expressions to find specific generator types or implementations.

Returns

Task< Workspace.XBR.Xperiflow.Core.RestApi.Generators.GetGeneratorCollectionResourceResponseContext >

ok

Parameters

Type	Name	Description
Workspace.XBR.Xperiflow.Core.Session.XperiflowSessionInfo	x_OS_SessionInfo	OneStream session info header object.
System.String	query	A pinq query string.
Workspace.XBR.Xperiflow.Utilities.Http.MemoizedCacheInfo	cacheInfo
System.Int32[]	mutedStatusCodes
System.Threading.CancellationToken	cancellationToken	A cancellation token that can be used by other objects or threads to receive notice of cancellation.

Exceptions

Workspace.XBR.Xperiflow.Core.RestApi.Exceptions.XperiflowApiException A server side error occurred.