Class FileTransferSpecification

A specification of files to be transferred between two different StorageSpecification.

Inheritance

object

FileTransferSpecification

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

Namespace: DNVGL.One.Compute.Core.FlowModel.DataTransfer

Assembly: DNVGL.One.Compute.Core.dll

Syntax

[DataContract]
public class FileTransferSpecification

Properties

DestinationSpecification

Gets or sets the destination specification.

Declaration

[DataMember]
public StorageSpecification DestinationSpecification { get; set; }

Property Value

Type	Description
StorageSpecification	The destination specification.

ExcludedFiles

Gets or sets the relative paths to files that should be excluded from data transfer. Paths must be relative to SourceSpecification. File patterns can be used, e.g. **/*.txt to match any .txt file in any sub directory of the root. The Glob standard (https://en.wikipedia.org/wiki/Glob_(programming) is supported.

Declaration

[DataMember]
public string[] ExcludedFiles { get; set; }

Property Value

Type	Description
string[]	The excluded files.

SelectedFiles

Gets or sets the relative paths to files selected for data transfer. Paths must be relative to SourceSpecification. File patterns can be used, e.g. **/*.txt to match any .txt file in any sub directory of the root. The Glob standard (https://en.wikipedia.org/wiki/Glob_(programming) is supported.

Declaration

[DataMember]
public string[] SelectedFiles { get; set; }

Property Value

Type	Description
string[]	The selected files.

SourceSpecification

Gets or sets the source specification.

Declaration

[DataMember]
public StorageSpecification SourceSpecification { get; set; }

Property Value

Type	Description
StorageSpecification	The source specification.

Methods

ToString()

Returns a string that represents this instance.

Declaration

public override string ToString()

Returns

Type	Description
string	A string that represents this instance.

Overrides

object.ToString()

TransferFilesToResultLake(IEnumerable<string>, IEnumerable<string>)

Creates a FileTransferSpecification for transferring files from the current directory to the Result Lake.

Declaration

public static FileTransferSpecification TransferFilesToResultLake(IEnumerable<string> selectedFiles = null, IEnumerable<string> excludedFiles = null)

Parameters

Type	Name	Description
IEnumerable<string>	selectedFiles	The files selected to be transferred. If null, all files will be selected.
IEnumerable<string>	excludedFiles	The files excluded from transfer. If null, no files will be excluded.

Returns

Type	Description
FileTransferSpecification	A FileTransferSpecification that specifies files to be transferred from the current directory to the Result Lake.