Interface ITransformation
Namespace: Unity.Cloud.Assets
Assembly: Unity.Cloud.Assets.dll
Syntax
public interface ITransformation
Properties
CreatedOn
The datetime at which the transformation was created
Declaration
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
string ErrorMessage { get; }
Property Value
| Type | Description |
|---|---|
| string |
InputDatasetId
The ID of the Dataset on which the transformation is applied
Declaration
DatasetId InputDatasetId { get; }
Property Value
| Type | Description |
|---|---|
| DatasetId |
InputFiles
The files on which the transformation is applied
Declaration
IEnumerable<string> InputFiles { get; }
Property Value
| Type | Description |
|---|---|
| IEnumerable<string> |
JobId
The job ID of the transformation
Declaration
string JobId { get; }
Property Value
| Type | Description |
|---|---|
| string |
LinkDatasetId
The ID of the Dataset that will be linked to the transformation if any
Declaration
DatasetId LinkDatasetId { get; }
Property Value
| Type | Description |
|---|---|
| DatasetId |
OutputDatasetId
The ID of the Dataset that will be created by the transformation if any
Declaration
DatasetId OutputDatasetId { get; }
Property Value
| Type | Description |
|---|---|
| DatasetId |
Progress
The progress of the transformation. This is a value between 0 and 100.
Declaration
int Progress { get; }
Property Value
| Type | Description |
|---|---|
| int |
StartedAt
The datetime at which the transformation was started
Declaration
DateTime StartedAt { get; }
Property Value
| Type | Description |
|---|---|
| DateTime |
Status
The status of the transformation
Declaration
TransformationStatus Status { get; }
Property Value
| Type | Description |
|---|---|
| TransformationStatus |
UpdatedAt
The datetime at which the transformation was last updated
Declaration
DateTime UpdatedAt { get; }
Property Value
| Type | Description |
|---|---|
| DateTime |
UserId
The user ID of the user who started the transformation
Declaration
UserId UserId { get; }
Property Value
| Type | Description |
|---|---|
| UserId |
WorkflowType
The type of transformation
Declaration
WorkflowType WorkflowType { get; }
Property Value
| Type | Description |
|---|---|
| WorkflowType |
Methods
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. |