Class XBRApiMetaFileSystem

The XBRApiMetaFileSystem class provides methods for instantiating a MetaFileSystemClient to interact with files and directories in the MetaFileSystem.

The XBRApiEtl class functions like the BRApi from OneStream. It can be thought of as the main entrypoint into programmatically extracting and loading data from various sources. For Example:

var metaFileSystemClient = XBRApi.MetaFileSystem.GetMetaFileSystemClient(si, connectionKey); bool directoryExists = metaFileSystemClient.DirectoryExistsAsync(filePath).Result; if (directoryExists) var directoryMetadata = metaFileSystemClient.GetDirectoryMetadataAsync(filePath).Result;

Namespace: Workspace.XBR.Xperiflow.SubApis

Assembly: Xperiflow.dll

Declaration

public class XBRApiMetaFileSystem

Methods

GetConnectionKey(SessionInfo, MetaFileSystemLocation)

Gets the MetaFileSystem connection key based on the provided Workspace.XBR.Xperiflow.MetaFileSystem.MetaFileSystemLocation.

Declaration

public string GetConnectionKey(SessionInfo si, MetaFileSystemLocation metaFileSystemLocation)

Returns

System.String

A connection key that can be used to instantiate an Workspace.XBR.Xperiflow.MetaFileSystem.IMetaFileSystemClient.

Parameters

Type	Name	Description
OneStream.Shared.Common.SessionInfo	si	The SessionInfo object
Workspace.XBR.Xperiflow.MetaFileSystem.MetaFileSystemLocation	metaFileSystemLocation	An [Workspace.XBR.Xperiflow.MetaFileSystem.MetaFileSystemLocation](../Xperiflow.MetaFileSystem/MetaFileSystemLocation.md) enum representing the MetaFileSystem connection key

GetMetaFileSystemClient(SessionInfo, string, OISToken)

Instantiates a [Workspace.XBR.Xperiflow.MetaFileSystem.IMetaFileSystemClient](../Xperiflow.MetaFileSystem/IMetaFileSystemClient.md) based on the provided connection key.

Declaration

public IMetaFileSystemClient GetMetaFileSystemClient(SessionInfo si, string connectionKey, OISToken oisToken = null)

Returns

Workspace.XBR.Xperiflow.MetaFileSystem.IMetaFileSystemClient

An [Workspace.XBR.Xperiflow.MetaFileSystem.IMetaFileSystemClient](../Xperiflow.MetaFileSystem/IMetaFileSystemClient.md) that can be used to interact with files and directories in the MetaFileSystem

Parameters

Type	Name	Description
OneStream.Shared.Common.SessionInfo	si	The SessionInfo object
System.String	connectionKey	The MetaFileSystem connection key
OneStream.Shared.Wcf.OISToken	oisToken

GetMetaFileSystemClient(SessionInfo, string, IHttpClientManager, IXperiflowStorageClient)

Instantiates a Workspace.XBR.Xperiflow.MetaFileSystem.IMetaFileSystemClient based on the provided connection key, Workspace.XBR.Xperiflow.Utilities.Http.IHttpClientManager, and Workspace.XBR.Xperiflow.Core.RestApi.Storage.IXperiflowStorageClient.

Declaration

public IMetaFileSystemClient GetMetaFileSystemClient(SessionInfo si, string connectionKey, IHttpClientManager httpClientManager, IXperiflowStorageClient xperiflowStorageClient)

Returns

Workspace.XBR.Xperiflow.MetaFileSystem.IMetaFileSystemClient

An [Workspace.XBR.Xperiflow.MetaFileSystem.IMetaFileSystemClient](../Xperiflow.MetaFileSystem/IMetaFileSystemClient.md) that can be used to interact with files and directories in the MetaFileSystem

Parameters

Type	Name	Description
OneStream.Shared.Common.SessionInfo	si	The SessionInfo object
System.String	connectionKey	The MetaFileSystem connection key
Workspace.XBR.Xperiflow.Utilities.Http.IHttpClientManager	httpClientManager	An IHTTPClientManager
Workspace.XBR.Xperiflow.Core.RestApi.Storage.IXperiflowStorageClient	xperiflowStorageClient	An IXperiflowStorageClient

GetMetaFileSystemClient(SessionInfo, MetaFileSystemLocation, OISToken)

Instantiates a Workspace.XBR.Xperiflow.MetaFileSystem.IMetaFileSystemClient based on a Workspace.XBR.Xperiflow.MetaFileSystem.MetaFileSystemLocation.

Declaration

public IMetaFileSystemClient GetMetaFileSystemClient(SessionInfo si, MetaFileSystemLocation metaFileSystemLocation, OISToken oisToken = null)

Returns

Workspace.XBR.Xperiflow.MetaFileSystem.IMetaFileSystemClient

An [Workspace.XBR.Xperiflow.MetaFileSystem.IMetaFileSystemClient](../Xperiflow.MetaFileSystem/IMetaFileSystemClient.md) that can be used to interact with files and directories in the MetaFileSystem

Parameters

Type	Name	Description
OneStream.Shared.Common.SessionInfo	si	The SessionInfo object
Workspace.XBR.Xperiflow.MetaFileSystem.MetaFileSystemLocation	metaFileSystemLocation	An [Workspace.XBR.Xperiflow.MetaFileSystem.MetaFileSystemLocation](../Xperiflow.MetaFileSystem/MetaFileSystemLocation.md) enum representing the MetaFileSystem connection key
OneStream.Shared.Wcf.OISToken	oisToken

GetMetaFileSystemClientFactory(SessionInfo, IXperiflowStorageClient, OISToken)

Instantiates a Workspace.XBR.Xperiflow.MetaFileSystem.IMetaFileSystemSessionClientFactory to create instances of the MetaFileSystemClient. The primary purpose of this factory is to inject the HttpClientManager and XperiflowClient into the MetaFileSystemClient and simplify the creation of the MetaFileSystemClient for developers.

Declaration

public IMetaFileSystemSessionClientFactory GetMetaFileSystemClientFactory(SessionInfo si, IXperiflowStorageClient xperiflowStorageClient = null, OISToken oisToken = null)

Returns

Workspace.XBR.Xperiflow.MetaFileSystem.IMetaFileSystemSessionClientFactory

An [Workspace.XBR.Xperiflow.MetaFileSystem.IMetaFileSystemSessionClientFactory](../Xperiflow.MetaFileSystem/IMetaFileSystemSessionClientFactory.md) that can be used to create instances of the MetaFileSystem Client

Parameters

Type	Name	Description
OneStream.Shared.Common.SessionInfo	si	The SessionInfo object
Workspace.XBR.Xperiflow.Core.RestApi.Storage.IXperiflowStorageClient	xperiflowStorageClient
OneStream.Shared.Wcf.OISToken	oisToken

Inherited Members

• System.Object.Equals(System.Object)
• System.Object.Equals(System.Object,System.Object)
• System.Object.GetHashCode
• System.Object.GetType
• System.Object.MemberwiseClone
• System.Object.ReferenceEquals(System.Object,System.Object)
• System.Object.ToString