Note: This release is in preview. Features described here don’t become generally available until the latest general availability date that Salesforce announces for this release. Before then, and where features are noted as beta, pilot, or developer preview, we can’t guarantee general availability within any particular time frame or at all. Make your purchase decisions only on the basis of generally available products and features.

DataLakeObjectInstance

Represents a data lake object (DLO). This object is available in API version 63.0 and later.

Supported Calls

create(), delete(), describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(), retrieve(), search(), undelete(), update(), upsert()

Fields

Field	Details
AccelerationEnabled	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates whether acceleration is turned on for external DLOs (YES) or not (NO). Acceleration increases how frequently DLO data is refreshed. Possible values are: `NO` `YES`
AccelerationSchedule	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Incremental refresh frequency for an external DLO. How often the system runs acceleration when AccelerationEnabled is YES. Possible values are: `EVERY_12_HOURS` `EVERY_24_HOURS` `EVERY_4_HOURS` `EVERY_7_DAYS`
Billable	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Indicates if this DLO is usage-metered (billable). Possible values are: `YES`
Category	Type string Properties Filter, Group, Nillable, Sort Description Type of DLO (for example: Engagement).
DataLakeObjectNamespacePrefix	Type string Properties Filter, Group, Nillable, Sort Description Namespace prefix of the related MktDataLakeObject developer name in a Developer Edition org. Used with the MktDataLakeObjectDeveloperName field to look up the single DLO that matches a namespaced DLO.
DataLakeObjectRef	Type picklist Properties Create, Filter, Group, Nillable, Restricted picklist, Sort Description Reference to the MktDataLakeObject that corresponds to this DLO when standard DLOs are enabled. Stores the standard DLO API reference (EnumOrId-style), for example Account_std__dll, in place of or in addition to the legacy MktDataLakeObject Id. Custom DLOs still use the ID in the other reference field. Possible values are: `Account_std__dll` `ApiGrounding_std__dll` `BenefitType_std__dll` `Benefit_std__dll` `Case_std__dll` `CatalogEnrichment_std__dll` `CatalogMetadataRelationship_std__dll` `CatalogMetadata_std__dll` `ConsumptionResourceTags_std__dll` `Contact_std__dll` `ForecastingFact_std__dll` `ForecastingItem_std__dll` `FtestMain_std__dll` `FtestMetadataDlo_std__dll` `GameDefinition_std__dll` `GameParticipant_std__dll` `GameReward_std__dll` `JournalSubType_std__dll` `JournalType_std__dll` `KnowledgeLayoutAssignment_std__dll` `KnowledgeLayout_std__dll` `ListEmail_std__dll` `LoyaltyAggrPointExprLedger_std__dll` `LoyaltyMemberCurrency_std__dll` `LoyaltyMemberTier_std__dll` `LoyaltyPartnerProduct_std__dll` `LoyaltyPgmEngmtAttrLimit_std__dll` `LoyaltyPgmEngmtAttrProm_std__dll` `LoyaltyPgmEngmtAttribute_std__dll` `LoyaltyPgmGroupMbrRlnsp_std__dll` `LoyaltyPgmMbrAttributeVal_std__dll` `LoyaltyPgmPartnerCurrency_std__dll` `LoyaltyPgmPartnerPromotion_std__dll` `LoyaltyProgramBadge_std__dll` `LoyaltyProgramCurrency_std__dll` `LoyaltyProgramMbrPromotion_std__dll` `LoyaltyProgramMemberCase_std__dll` `LoyaltyProgramMemberMerge_std__dll` `LoyaltyProgramPartner_std__dll` `LoyaltyProgram_std__dll` `LoyaltyTierBenefit_std__dll` `LoyaltyTierGroup_std__dll` `LoyaltyTier_std__dll` `ManagedContentVariant_std__dll` `ManagedContent_std__dll` `MemberBenefit_std__dll` `OpportunityContactRole_std__dll` `ProductCatalog_std__dll` `ProductCategoryProduct_std__dll` `ProductCategory_std__dll` `PromotionLoyaltyPtnrProdt_std__dll` `PromotionMarketSegment_std__dll` `PromotionPartyUsage_std__dll` `Promotion_std__dll` `VoucherDefinition_std__dll` `Voucher_std__dll`
DataLakeObjectStatus	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Status of this DLO. You can’t change a DLO when it’s in the PROCESSING state. If you make any changes to a DLO, this field will be in the PROCESSING state, and later ACTIVE when the update is complete. Possible values are: `ACTIVE` `DELETING` `ERROR` `INACTIVE` `NONE` `PROCESSING` The default value is `PROCESSING`.
DeletionRecordsDataLakeObject	Type string Properties Filter, Group, Nillable, Sort Description API name of the DLO that stores deletion records associated with this DLO.
Description	Type string Properties Create, Filter, Group, Nillable, Sort, Update Description Description of the DLO.
ExternalName	Type string Properties Filter, Group, Nillable, Sort Description Name of the DLO in the external data source.
ExternalObjectErrorCode	Type string Properties Filter, Group, Nillable, Sort Description Provider-specific or internal error code when the external DLO reports an error (pairs with ExternalObjectErrorStatus).
ExternalObjectErrorStatus	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Activity status of an external DLO. Possible values are: `ACTIVE` `ERROR`
HydrationStatus	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description How fully this DLO has been hydrated in storage (all data available vs. partial vs. not yet loaded). Possible values are: `Hydrated` `PartiallyHydrated` `Unhydrated`
LastDataChangeStatusDateTime	Type dateTime Properties Filter, Nillable, Sort Description Date and time of the most recent data change or ingestion status transition relevant to this DLO.
LastDataChangeStatusErrorCode	Type string Properties Filter, Group, Nillable, Sort Description Error code explaining the last data change failure.
LastReferencedDate	Type dateTime Properties Filter, Nillable, Sort Description Last date when a user referenced this record.
LastRefreshDate	Type dateTime Properties Filter, Nillable, Sort Description Last date when ingested or synced data for this DLO was refreshed.
LastSyncedFingerprint	Type textarea Properties Nillable Description Content or schema fingerprint from the last successful sync, used to detect when upstream data or layout changes.
LastViewedDate	Type dateTime Properties Filter, Nillable, Sort Description Last date when a user viewed this record in the UI.
MktDataLakeObjectDeveloperName	Type string Properties Filter, Group, Nillable, Sort Description Developer name of the related MktDataLakeObject. For a namespaced DLO, this is paired with DataLakeObjectNamespacePrefix. For a standard DLO, this may be the standard DLO’s API name.
MktDataLakeObjectLabel	Type string Properties Filter, Group, Nillable, Sort Description User-defined label of the DLO.
Name	Type string Properties Create, Filter, Group, idLookup, Sort, Update Description Name of the DLO.
ProblemRecordsDataLakeObject	Type string Properties Filter, Group, Nillable, Sort Description API name of the DLO that stores failed records for this DLO.
Storage	Type picklist Properties Filter, Group, Nillable, Restricted picklist, Sort Description Where the DLO’s physical data resides. For standard DLOs, the query path can default this to LOCAL when not set. Possible values are: `EXTERNAL`—External `LOCAL`—Local
SyncStatus	Type picklist Properties Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort Description Synchronization status of the DLO. For external DLOs, this field exposes connection issues. With standard DLOs, this field is read and written at the same time as DataLakeObjectStatus to reflect ingestion state. Possible values are: `ACTIVE` `DELETING` `ERROR` `INACTIVE` `NONE` `PROCESSING` The default value is `PROCESSING`.
TotalNumberOfFields	Type int Properties Filter, Group, Nillable, Sort Description Total number of fields in the DLO.
TotalRecords	Type long Properties Filter, Group, Nillable, Sort Description Total number of records stored in the DLO.

Object Reference for the Salesforce Platform

DataLakeObjectInstance

Supported Calls

Fields