Interface ITransformation

Namespace: Unity.Cloud.Assets

Assembly: Unity.Cloud.Assets.dll

Syntax

public interface ITransformation

Properties

CacheConfiguration

The caching configuration for the transformation.

Declaration

TransformationCacheConfiguration CacheConfiguration { get; }

Property Value

Type	Description
TransformationCacheConfiguration

CreatedOn

The datetime at which the transformation was created

Declaration

[Obsolete("Use TransformationProperties.Created instead.")]
DateTime CreatedOn { get; }

Property Value

Type	Description
DateTime

Descriptor

The descriptor of the transformation.

Declaration

TransformationDescriptor Descriptor { get; }

Property Value

Type	Description
TransformationDescriptor

ErrorMessage

If the transformation failed, this will contain the associated error message

Declaration

[Obsolete("Use TransformationProperties.ErrorMessage instead.")]
string ErrorMessage { get; }

Property Value

Type	Description
string

InputDatasetId

The ID of the Dataset on which the transformation is applied

Declaration

[Obsolete("Use Descriptor.DatasetId instead.")]
DatasetId InputDatasetId { get; }

Property Value

Type	Description
DatasetId

InputFiles

The files on which the transformation is applied

Declaration

[Obsolete("Use TransformationProperties.InputFilePaths instead.")]
IEnumerable<string> InputFiles { get; }

Property Value

Type	Description
IEnumerable<string>

JobId

The job ID of the transformation

Declaration

[Obsolete("Use TransformationProperties.JobId instead.")]
string JobId { get; }

Property Value

Type	Description
string

LinkDatasetId

The ID of the Dataset that will be linked to the transformation if any

Declaration

[Obsolete("Use TransformationProperties.LinkDatasetId instead.")]
DatasetId LinkDatasetId { get; }

Property Value

Type	Description
DatasetId

OutputDatasetId

The ID of the Dataset that will be created by the transformation if any

Declaration

[Obsolete("Use TransformationProperties.OutputDatasetId instead.")]
DatasetId OutputDatasetId { get; }

Property Value

Type	Description
DatasetId

Progress

The progress of the transformation. This is a value between 0 and 100.

Declaration

[Obsolete("Use TransformationProperties.Progress instead.")]
int Progress { get; }

Property Value

Type	Description
int

StartedAt

The datetime at which the transformation was started

Declaration

[Obsolete("Use TransformationProperties.Started instead.")]
DateTime StartedAt { get; }

Property Value

Type	Description
DateTime

Status

The status of the transformation

Declaration

[Obsolete("Use TransformationProperties.StatusName instead.")]
TransformationStatus Status { get; }

Property Value

Type	Description
TransformationStatus

UpdatedAt

The datetime at which the transformation was last updated

Declaration

[Obsolete("Use TransformationProperties.Updated instead.")]
DateTime UpdatedAt { get; }

Property Value

Type	Description
DateTime

UserId

The user ID of the user who started the transformation

Declaration

[Obsolete("Use TransformationProperties.UserId instead.")]
UserId UserId { get; }

Property Value

Type	Description
UserId

WorkflowName

The name of the workflow

Declaration

[Obsolete("Use TransformationProperties.WorkflowName instead.")]
string WorkflowName { get; }

Property Value

Type	Description
string

WorkflowType

The type of transformation

Declaration

[Obsolete("Use TransformationProperties.WorkflowType instead.")]
WorkflowType WorkflowType { get; }

Property Value

Type	Description
WorkflowType

Methods

GetPropertiesAsync(CancellationToken)

Returns the properties of the transformation.

Declaration

Task<TransformationProperties> GetPropertiesAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A token that can be used to cancel the request.

Returns

Type	Description
Task<TransformationProperties>	A task whose result is the TransformationProperties of the transformation.

RefreshAsync(CancellationToken)

Refreshes the transformation properties.

Declaration

Task RefreshAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A token that can be used to cancel the request.

Returns

Type	Description
Task	A task with no result.

TerminateAsync(CancellationToken)

Cancels the transformation.

Declaration

Task TerminateAsync(CancellationToken cancellationToken)

Parameters

Type	Name	Description
CancellationToken	cancellationToken	A token that can be used to cancel the request.

Returns

Type	Description
Task	A task with no result.

WithCacheConfigurationAsync(TransformationCacheConfiguration, CancellationToken)

Returns a transformation configured with the specified caching configuration.

Declaration

Task<ITransformation> WithCacheConfigurationAsync(TransformationCacheConfiguration transformationCacheConfiguration, CancellationToken cancellationToken)

Parameters

Type	Name	Description
TransformationCacheConfiguration	transformationCacheConfiguration	The caching configuration for the transformation.
CancellationToken	cancellationToken	A token that can be used to cancel the request.

Returns

Type	Description
Task<ITransformation>	A task whose result is an ITransformation with cached values specified by the caching configurations.