Struct DeploymentStatus

A struct that represents the deployment status description of an item, relative to its 'live' counterpart, and the latest deployment. This should NOT be used to represent the validity of the item itself, or other internal validations, use AssetState for that purpose.

Inherited Members

ValueType.Equals(object)

ValueType.GetHashCode()

ValueType.ToString()

object.Equals(object, object)

object.GetType()

object.ReferenceEquals(object, object)

Namespace: Unity.Services.DeploymentApi.Editor

Assembly: Unity.Services.DeploymentApi.dll

Syntax

[Serializable]
public struct DeploymentStatus

Constructors

DeploymentStatus(string, string, SeverityLevel)

Creates a DeploymentStatus struct

Declaration

public DeploymentStatus(string message = null, string messageDetail = null, SeverityLevel messageSeverity = SeverityLevel.None)

Parameters

Type	Name	Description
string	message	The DeploymentStatus message if any
string	messageDetail	Details regarding the message
SeverityLevel	messageSeverity	The severity of the message

Fields

Empty

An empty status.

Declaration

public static readonly DeploymentStatus Empty

Field Value

Type	Description
DeploymentStatus

FailedToDeploy

A status to represent an item that failed to deploy.

Declaration

public static readonly DeploymentStatus FailedToDeploy

Field Value

Type	Description
DeploymentStatus

ModifiedLocally

A status to represent an item that was modified locally.

Declaration

public static readonly DeploymentStatus ModifiedLocally

Field Value

Type	Description
DeploymentStatus

UpToDate

A status to represent an item that is up to date with the remote.

Declaration

public static readonly DeploymentStatus UpToDate

Field Value

Type	Description
DeploymentStatus

Properties

Message

Message associated with a deployment result

Declaration

public string Message { get; }

Property Value

Type	Description
string

MessageDetail

Details associated with a deployment result.

Declaration

public string MessageDetail { get; }

Property Value

Type	Description
string

MessageSeverity

Severity of the deployment message level.

Declaration

public SeverityLevel MessageSeverity { get; }

Property Value

Type	Description
SeverityLevel

Methods

GetDeployed(string)

Helper method for Deployed status

Declaration

public static DeploymentStatus GetDeployed(string details)

Parameters

Type	Name	Description
string	details	Details of the status

Returns

Type	Description
DeploymentStatus	The Deployment Status

GetDeploying(string)

Helper method for Deploying status

Declaration

public static DeploymentStatus GetDeploying(string details = null)

Parameters

Type	Name	Description
string	details	Details of the status

Returns

Type	Description
DeploymentStatus	The Deployment Status

GetFailedToDelete(Exception, string)

Helper method for Failed to delete status

Declaration

public static DeploymentStatus GetFailedToDelete(Exception e, string path)

Parameters

Type	Name	Description
Exception	e	Exception details
string	path	Path of asset that failed

Returns

Type	Description
DeploymentStatus	The Deployment Status

GetFailedToDeploy(string)

Helper method for Failed to deploy status

Declaration

public static DeploymentStatus GetFailedToDeploy(string details)

Parameters

Type	Name	Description
string	details	Details of the status

Returns

Type	Description
DeploymentStatus	The Deployment Status

GetFailedToFetch(string)

Helper method for Failed to fetch status

Declaration

public static DeploymentStatus GetFailedToFetch(string details)

Parameters

Type	Name	Description
string	details	Details of the status

Returns

Type	Description
DeploymentStatus	The Deployment Status

GetFailedToLoad(Exception, string)

Helper method for Failed to load status

Declaration

public static DeploymentStatus GetFailedToLoad(Exception e, string path)

Parameters

Type	Name	Description
Exception	e	Exception details
string	path	Path of asset that failed

Returns

Type	Description
DeploymentStatus	The Deployment Status

GetFailedToRead(Exception, string)

Helper method for Failed to read status

Declaration

public static DeploymentStatus GetFailedToRead(Exception e, string path)

Parameters

Type	Name	Description
Exception	e	Exception details
string	path	Path of asset that failed

Returns

Type	Description
DeploymentStatus	The Deployment Status

GetFailedToSerialize(Exception, string)

Helper method for Failed to serialize status

Declaration

public static DeploymentStatus GetFailedToSerialize(Exception e, string path)

Parameters

Type	Name	Description
Exception	e	Exception details
string	path	Path of asset that failed

Returns

Type	Description
DeploymentStatus	The Deployment Status

GetFailedToWrite(Exception, string)

Helper method for Failed to write status

Declaration

public static DeploymentStatus GetFailedToWrite(Exception e, string path)

Parameters

Type	Name	Description
Exception	e	Exception details
string	path	Path of asset that failed

Returns

Type	Description
DeploymentStatus	The Deployment Status

GetFetched(string)

Helper method for Fetched status

Declaration

public static DeploymentStatus GetFetched(string details)

Parameters

Type	Name	Description
string	details	Details of the status

Returns

Type	Description
DeploymentStatus	The Deployment Status

GetFetching(string)

Helper field for Failed to fetching status

Declaration

public static DeploymentStatus GetFetching(string details)

Parameters

Type	Name	Description
string	details	Details of the status

Returns

Type	Description
DeploymentStatus	The Deployment Status

GetPartialDeploy(string)

Helper method for Partial deploy status

Declaration

public static DeploymentStatus GetPartialDeploy(string details)

Parameters

Type	Name	Description
string	details	Details of the status

Returns

Type	Description
DeploymentStatus	The Deployment Status

GetPartialFetch(string)

Helper method for Partial fetch status

Declaration

public static DeploymentStatus GetPartialFetch(string details)

Parameters

Type	Name	Description
string	details	Details of the status

Returns

Type	Description
DeploymentStatus	The Deployment Status