OptionalaliasOptionalchildrenType definitions for child types, if the type has any.
Examples: CustomField and CompactLayout on CustomObject
Array with the list of child XML fragments that match this metadata type
Name of the directory where components are located in a package.
OptionalfolderIf the type is a folder type (container for components), the id of the type it is a container for.
OptionalfolderIf the type is contained in folders, the id of the type that contains it.
True when the metadata has a separate content file(s) this implies that any -meta.xml file is a meta file and not a content file and should not be renamed.
Unique identifier of the metadata type. Usually the API name lowercased.
OptionalignoreIf the parent name should be ignored when constructing the type's fullName
OptionalignoreWhether or not to ignore the fullName that's parsed from the file path. If true, the metadata type's name will be used instead. For example, CustomLabels instead of MyLabels.
OptionalinWhether or not components are stored in folders.
Examples: Reports, Dashboards, Documents, EmailTemplates
OptionalisWhether the component is supported by the Metadata API and therefore should be included within a manifest.
Human readable label for the metadata type, used in UI and commands This is derived from the name of the metadata type and formatted to be more readable.
OptionallegacyWhen converting deploying source, this will update the suffix in the output or temporary directory (metadata format) Use this, along with additional suffix keys in the registry, to support incorrect suffixes from existing code
OptionalmetaMetaFile suffix
An override to the default "-meta.xml" suffix.
Examples: "_meta.json" for DigitalExperience.
API name of the metadata type.
OptionalstrategiesConfiguration for resolving and converting components of the type.
OptionalstrictWhether or not components are required to reside in a folder named after the type's directoryName.
OptionalsuffixFile suffix
Some types may not have one, such as those made up of varying file extensions.
Examples: LightningComponentBundles, Documents, StaticResources
OptionalsupportsWhether the component can be partially deleted, such as metadata types that are made up of multiple files.
Examples: LightningComponentBundle, ExperienceBundle, StaticResource, and DigitalExperienceBundle
OptionalsupportsWhether or not components of the same type can be can be specified with the wildcard character, and by name in a manifest
<members>*</members>
<members>Account</members>
<name>CustomObject</name>
OptionalunaddressableWhether the component requires the parent to be present when deploying/retrieving
OptionaluniqueThe xml attribute used as the unique identifier when parsing the xml
OptionalxmlThe XML element name for the type in the xml file used for constructing child components.
Name of the XML tag used for this metadata type
Use MetadataType.name instead
Whenever this type is requested, return the aliasFor type instead