{
"sections": [
"title",
"description",
"file_information",
"directory_location",
"fields",
"sub_types",
"wsdl_segment",
"declarative_metadata_sample_definition"
],
"title": "PlatformCachePartition - Metadata API",
"description": "Represents a partition in the Platform Cache. This type extends the Metadata metadata type and inherits its fullName field.",
"file_information": ".cachePartition",
"directory_location": "cachePartitions",
"fields_columns": [
"type",
"description"
],
"fields": {
"description": {
"type": "string",
"description": "Describes the cache partition."
},
"isDefaultPartition": {
"type": "boolean",
"description": "Indicates whether this cache partition is the default partition in your organization (true) or not (false).",
"required": true
},
"masterLabel": {
"type": "string",
"description": "The label of the cache partition that appears in the Salesforce user interface.",
"required": true
},
"platformCachePartitionTypes": {
"type": "PlatformCachePartitionType[]",
"description": "An array of cache types that the partition can store."
}
},
"sub_types": {
"PlatformCachePartitionType": {
"allocatedCapacity": {
"type": "int",
"description": "The total storage capacity, in megabytes (MB), that is allocated for the cache type, including free, purchased, and trial cache. Purchased capacity includes organization-wide cache, which can be used in any partition, and namespace-specific cache, which can be used only in partitions associated with a namespace.",
"required": true
},
"allocatedPartnerCapacity": {
"type": "int",
"description": "Free capacity, in megabytes (MB). allocated to Developer Edition orgs for the cache type. Use this capacity with security-reviewed managed packages. Available in API version 51.0 and later.",
"required": true
},
"allocatedPurchasedCapacity": {
"type": "int",
"description": "The amount of namespace-specific purchased storage capacity, in MB, that is allocated for the cache type.",
"required": true
},
"allocatedTrialCapacity": {
"type": "int",
"description": "The amount of trial cache space, in MB, that is allocated for the cache type.",
"required": true
},
"cacheType": {
"type": "PlatformCacheType (enumeration of type string)",
"description": "The type of cache. Valid values are: Session—Session cache Organization—Org cache"
}
}
},
"wsdl_segment": "```xml\n\n \n \n \n\n\n \n \n \n \n \n \n \n \n \n \n\n\n \n \n \n \n \n \n \n\n\n \n \n \n \n\n```",
"declarative_metadata_sample_definition": [
{
"description": "The following is an example of a PlatformCachePartition component.",
"code": "\n\n Custom partition and marked as default.\n true\n myPartition\n \n 10\n 5\n Session\n \n \n 5\n 5\n Organization\n \n"
},
{
"description": "If a namespace is defined in your organization, add the namespace prefix to your partition name. For example:",
"code": "Namespace.myPartition"
}
]
}