Apex Developer Guide

Apex Developer Guide
Getting Started with Apex
Writing Apex
Running Apex
Debugging, Testing, and Deploying Apex
Apex Language Reference
Apex DML Operations
ApexPages Namespace
AppLauncher Namespace
Approval Namespace
Auth Namespace
Cache Namespace
Canvas Namespace
ChatterAnswers Namespace
ConnectApi Namespace
Database Namespace
Datacloud Namespace
DataSource Namespace
Dom Namespace
EventBus Namespace
Flow Namespace
KbManagement Namespace
Messaging Namespace
Metadata Namespace
AnalyticsCloudComponentLayoutItem Class
ConsoleComponent Class
Container Class
CustomConsoleComponents Class
CustomMetadata Class
CustomMetadataValue Class
DeployCallback Interface
DeployCallbackContext Class
DeployContainer Class
DeployContainer Methods
DeployDetails Class
DeployMessage Class
DeployProblemType Enum
DeployResult Class
DeployStatus Enum
FeedItemTypeEnum Enum
FeedLayout Class
FeedLayoutComponent Class
FeedLayoutComponentType Enum
FeedLayoutFilter Class
FeedLayoutFilterPosition Enum
FeedLayoutFilterType Enum
Layout Class
LayoutColumn Class
LayoutHeader Enum
LayoutItem Class
LayoutSection Class
LayoutSectionStyle Enum
Metadata Class
MetadataType Enum
MetadataValue Class
MiniLayout Class
Operations Class
PlatformActionList Class
PlatformActionListContextEnum Enum
PlatformActionListItem Class
PlatformActionTypeEnum Enum
PrimaryTabComponents Class
QuickActionList Class
QuickActionListItem Class
RelatedContent Class
RelatedContentItem Class
RelatedList Class
RelatedListItem Class
ReportChartComponentLayoutItem Class
ReportChartComponentSize Enum
SidebarComponent Class
SortOrder Enum
SubtabComponents Class
SummaryLayoutStyleEnum Enum
SummaryLayout Class
SummaryLayoutItem Class
UiBehavior Enum
Process Namespace
QuickAction Namespace
Reports Namespace
Schema Namespace
Search Namespace
Sfc Namespace
Site Namespace
Support Namespace
System Namespace
TerritoryMgmt Namespace
TxnSecurity Namespace
UserProvisioning Namespace
VisualEditor Namespace
wave Namespace
Appendices
Glossary
PDF

Newer Version Available

This content describes an older version of this product. View Latest

DeployContainer Class

Represents a container for custom metadata components to be deployed.

Namespace

Metadata

Usage

Use Metadata.DeployContainer to manage custom metadata components for deployment. A container must have one or more components before being deployed.

Example

1// Use DeployContainer for deployment
2Metadata.DeployContainer mdContainer = new Metadata.DeployContainer();
3mdContainer.addMetadata(customMetadata);
4
5...
6
7// Enqueue deploy
8Metadata.Operations.enqueueDeployment(mdContainer, callback);

DeployContainer Methods

The following are methods for DeployContainer.

addMetadata(md)

Add a custom metadata component to the container.

Signature

public void addMetadata(Metadata.Metadata md)

Parameters

md
Type: Metadata.Metadata
A custom metadata component class that derives from Metadata.Metadata. Avoid adding components to a Metadata.DeployContainerthat have the same Metadata.Metadata.fullName because it causes deployment errors.

Return Value

Type: void

clone()

Makes a duplicate copy of the Metadata.DeployContainer.

Signature

public Object clone()

Return Value

Type: Object

getMetadata()

Retrieves a list of custom metadata components from the container.

Signature

public List<Metadata.Metadata> getMetadata()

Return Value

Type: List<Metadata.Metadata>

removeMetadata(md)

Removes a metadata component from the container.

Signature

public Boolean removeMetadata(Metadata.Metadata md)

Parameters

md
Type: Metadata.Metadata
Metadata component to remove.

Return Value

Type: Boolean

Returns true if the container changed as a result of the call.

removeMetadataByFullName(fullName)

Removes a metadata component from the container using the component’s full name.

Signature

public Boolean removeMetadataByFullName(String fullName)

Parameters

fullName
Type: String
Full name of the component to remove.

Return Value

Type: Boolean

Returns true if the container changed as a result of the call.