DeployMessage Class

Represents result information for the deployment of a metadata component.

Namespace

Metadata

Usage

Use DeployMessage to access detailed information about component deployments. Salesforce provides a list of DeployMessages for a completed deployment via the DeployDetails and DeployResults instances sent in the DeployCallback.handleResult() callback.

DeployMessage Properties

The following are properties for DeployMessage.

  • changed
    Determines whether the component was changed after deployment. If true, the component was changed as a result of the deployment. If false, the deployed component was the same as the corresponding component already in the org.
  • columnNumber
    Each component is represented by a text file. If an error occurs during deployment, this property represents the column of the text file where the error occurred.
  • componentType
    The metadata type of the component in the deployment.
  • created
    If true, the component was created as a result of the deployment. If false, the component was modified as a result of the deployment.
  • createdDate
    The date and time when the component was created as a result of the deployment.
  • deleted
    If true, the component was deleted as a result of the deployment. If false, the component was either new or modified as result of the deployment.
  • fileName
    The name of the file in the metadata archive used to deploy the component.
  • fullName
    Full name for the custom metadata component.
  • id
    ID of the component that was deployed.
  • lineNumber
    Each component is represented by a text file. If an error occurs during deployment, this field represents the line number of the text file where the error occurred.
  • problem
    If an error or warning occurred, this field contains a description of the problem that caused the deployment to fail.
  • problemType
    Indicates the problem type, for example, an error or warning.
  • success
    Indicates whether the component was successfully deployed (true) or not (false).

changed

Determines whether the component was changed after deployment. If true, the component was changed as a result of the deployment. If false, the deployed component was the same as the corresponding component already in the org.

Signature

public Boolean changed {get; set;}

Property Value

Type: Boolean

columnNumber

Each component is represented by a text file. If an error occurs during deployment, this property represents the column of the text file where the error occurred.

Signature

public Integer columnNumber {get; set;}

Property Value

Type: Integer

componentType

The metadata type of the component in the deployment.

Signature

public String componentType {get; set;}

Property Value

Type: String

created

If true, the component was created as a result of the deployment. If false, the component was modified as a result of the deployment.

Signature

public Boolean created {get; set;}

Property Value

Type: Boolean

createdDate

The date and time when the component was created as a result of the deployment.

Signature

public Datetime createdDate {get; set;}

Property Value

Type: Datetime

deleted

If true, the component was deleted as a result of the deployment. If false, the component was either new or modified as result of the deployment.

Signature

public Boolean deleted {get; set;}

Property Value

Type: Boolean

fileName

The name of the file in the metadata archive used to deploy the component.

Signature

public String fileName {get; set;}

Property Value

Type: String

fullName

Full name for the custom metadata component.

Signature

public String fullName {get; set;}

Property Value

Type: String

id

ID of the component that was deployed.

Signature

public Id id {get; set;}

Property Value

Type: Id

lineNumber

Each component is represented by a text file. If an error occurs during deployment, this field represents the line number of the text file where the error occurred.

Signature

public Integer lineNumber {get; set;}

Property Value

Type: Integer

problem

If an error or warning occurred, this field contains a description of the problem that caused the deployment to fail.

Signature

public String problem {get; set;}

Property Value

Type: String

problemType

Indicates the problem type, for example, an error or warning.

Signature

public Metadata.DeployProblemType problemType {get; set;}

Property Value

Type: Metadata.DeployProblemType

success

Indicates whether the component was successfully deployed (true) or not (false).

Signature

public Boolean success {get; set;}

Property Value

Type: Boolean

DeployMessage Methods

The following are methods for DeployMessage.

  • clone()
    Makes a duplicate copy of the Metadata.DeployMessage.

clone()

Makes a duplicate copy of the Metadata.DeployMessage.

Signature

public Object clone()

Return Value

Type: Object