DataLakeObjectInstance

Represents a data lake object (DLO).

Introduced in API version 53.0.

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

  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 58.0
  • Description: Indicates whether acceleration is turned on for external DLOs (YES) or not (NO). Acceleration increases how frequently DLO data is refreshed.
  • Possible values:
    • NO — NO
    • YES — YES
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 58.0
  • Description: Incremental refresh frequency for an external DLO. How often the system runs acceleration when AccelerationEnabled is YES.
  • Possible values:
    • EVERY_12_HOURS — EVERY_12_HOURS
    • EVERY_24_HOURS — EVERY_24_HOURS
    • EVERY_4_HOURS — EVERY_4_HOURS
    • EVERY_7_DAYS — EVERY_7_DAYS
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 61.0
  • Description: Indicates if this DLO is usage-metered (billable).
  • Possible values:
    • YES — YES
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 56.0
  • Description: Type of DLO (for example: Engagement).
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 63.0
  • 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.
  • Type: picklist
  • Properties: Create, Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 63.0
  • 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:
    • Account_std__dll — Account_std__dll
    • ApiGrounding_std__dll — ApiGrounding_std__dll
    • BenefitType_std__dll — BenefitType_std__dll
    • Benefit_std__dll — Benefit_std__dll
    • Case_std__dll — Case_std__dll
    • CatalogEnrichment_std__dll — CatalogEnrichment_std__dll
    • CatalogMetadataRelationship_std__dll — CatalogMetadataRelationship_std__dll
    • CatalogMetadata_std__dll — CatalogMetadata_std__dll
    • ConsumptionResourceTags_std__dll — ConsumptionResourceTags_std__dll
    • Contact_std__dll — Contact_std__dll
    • ForecastingFact_std__dll — ForecastingFact_std__dll
    • ForecastingItem_std__dll — ForecastingItem_std__dll
    • FtestMain_std__dll — FtestMain_std__dll
    • FtestMetadataDlo_std__dll — FtestMetadataDlo_std__dll
    • GameDefinition_std__dll — GameDefinition_std__dll
    • GameParticipant_std__dll — GameParticipant_std__dll
    • GameReward_std__dll — GameReward_std__dll
    • JournalSubType_std__dll — JournalSubType_std__dll
    • JournalType_std__dll — JournalType_std__dll
    • KnowledgeLayoutAssignment_std__dll — KnowledgeLayoutAssignment_std__dll
    • KnowledgeLayout_std__dll — KnowledgeLayout_std__dll
    • ListEmail_std__dll — ListEmail_std__dll
    • LoyaltyAggrPointExprLedger_std__dll — LoyaltyAggrPointExprLedger_std__dll
    • LoyaltyMemberCurrency_std__dll — LoyaltyMemberCurrency_std__dll
    • LoyaltyMemberTier_std__dll — LoyaltyMemberTier_std__dll
    • LoyaltyPartnerProduct_std__dll — LoyaltyPartnerProduct_std__dll
    • LoyaltyPgmEngmtAttrLimit_std__dll — LoyaltyPgmEngmtAttrLimit_std__dll
    • LoyaltyPgmEngmtAttrProm_std__dll — LoyaltyPgmEngmtAttrProm_std__dll
    • LoyaltyPgmEngmtAttribute_std__dll — LoyaltyPgmEngmtAttribute_std__dll
    • LoyaltyPgmGroupMbrRlnsp_std__dll — LoyaltyPgmGroupMbrRlnsp_std__dll
    • LoyaltyPgmMbrAttributeVal_std__dll — LoyaltyPgmMbrAttributeVal_std__dll
    • LoyaltyPgmPartnerCurrency_std__dll — LoyaltyPgmPartnerCurrency_std__dll
    • LoyaltyPgmPartnerPromotion_std__dll — LoyaltyPgmPartnerPromotion_std__dll
    • LoyaltyProgramBadge_std__dll — LoyaltyProgramBadge_std__dll
    • LoyaltyProgramCurrency_std__dll — LoyaltyProgramCurrency_std__dll
    • LoyaltyProgramMbrPromotion_std__dll — LoyaltyProgramMbrPromotion_std__dll
    • LoyaltyProgramMemberCase_std__dll — LoyaltyProgramMemberCase_std__dll
    • LoyaltyProgramMemberMerge_std__dll — LoyaltyProgramMemberMerge_std__dll
    • LoyaltyProgramPartner_std__dll — LoyaltyProgramPartner_std__dll
    • LoyaltyProgram_std__dll — LoyaltyProgram_std__dll
    • LoyaltyTierBenefit_std__dll — LoyaltyTierBenefit_std__dll
    • LoyaltyTierGroup_std__dll — LoyaltyTierGroup_std__dll
    • LoyaltyTier_std__dll — LoyaltyTier_std__dll
    • ManagedContentVariant_std__dll — ManagedContentVariant_std__dll
    • ManagedContent_std__dll — ManagedContent_std__dll
    • MemberBenefit_std__dll — MemberBenefit_std__dll
    • OpportunityContactRole_std__dll — OpportunityContactRole_std__dll
    • ProductCatalog_std__dll — ProductCatalog_std__dll
    • ProductCategoryProduct_std__dll — ProductCategoryProduct_std__dll
    • ProductCategory_std__dll — ProductCategory_std__dll
    • PromotionLoyaltyPtnrProdt_std__dll — PromotionLoyaltyPtnrProdt_std__dll
    • PromotionMarketSegment_std__dll — PromotionMarketSegment_std__dll
    • PromotionPartyUsage_std__dll — PromotionPartyUsage_std__dll
    • Promotion_std__dll — Promotion_std__dll
    • VoucherDefinition_std__dll — VoucherDefinition_std__dll
    • Voucher_std__dll — Voucher_std__dll

  • Type: picklist

  • Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

  • Introduced: API version 54.0

  • 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.

    The default value is PROCESSING.

  • Possible values:

    • ACTIVE — ACTIVE
    • DELETING — DELETING
    • ERROR — ERROR
    • INACTIVE — INACTIVE
    • NONE — NONE
    • PROCESSING — PROCESSING (default)

  • Default value: PROCESSING

  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 64.0
  • Description: API name of the DLO that stores deletion records associated with this DLO.
  • Type: string
  • Properties: Create, Filter, Group, Nillable, Sort, Update
  • Description: Description of the DLO.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 56.0
  • Description: Name of the DLO in the external data source.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 59.0
  • Description: Provider-specific or internal error code when the external DLO reports an error (pairs with ExternalObjectErrorStatus).
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 59.0
  • Description: Activity status of an external DLO.
  • Possible values:
    • ACTIVE — ACTIVE
    • ERROR — ERROR
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 63.0
  • Description: How fully this DLO has been hydrated in storage (all data available vs. partial vs. not yet loaded).
  • Possible values:
    • Hydrated — Hydrated
    • PartiallyHydrated — PartiallyHydrated
    • Unhydrated — Unhydrated
  • Type: datetime
  • Properties: Filter, Nillable, Sort
  • Introduced: API version 63.0
  • Description: Date and time of the most recent data change or ingestion status transition relevant to this DLO.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 63.0
  • Description: Error code explaining the last data change failure.
  • Type: datetime
  • Properties: Filter, Nillable, Sort
  • Description: Last date when ingested or synced data for this DLO was refreshed.
  • Type: textarea
  • Properties: Nillable
  • Introduced: API version 63.0
  • Description: Content or schema fingerprint from the last successful sync, used to detect when upstream data or layout changes.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 63.0
  • 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**.**

  • Type: reference

  • Properties: Create, Filter, Group, Nillable, Sort

  • Introduced: API version 53.0

  • Relationship name: MktDataLakeObject

  • Relationship type: relationship

  • Refers to: MktDataLakeObject

  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 64.0
  • Description: User-defined label of the DLO.
  • Type: string
  • Properties: Create, Filter, Group, idLookup, Sort, Update
  • Description: Name of the DLO.
  • Type: string
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 61.0
  • Description: API name of the DLO that stores failed records for this DLO.
  • Type: picklist
  • Properties: Filter, Group, Nillable, Restricted picklist, Sort
  • Introduced: API version 58.0
  • Description: Where the DLO’s physical data resides. For standard DLOs, the query path can default this to LOCAL when not set.
  • Possible values:
    • EXTERNAL — EXTERNAL
    • LOCAL — LOCAL

  • Type: picklist

  • Properties: Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort

  • Introduced: API version 63.0

  • 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.

    The default value is PROCESSING.

  • Possible values:

    • ACTIVE — ACTIVE
    • DELETING — DELETING
    • ERROR — ERROR
    • INACTIVE — INACTIVE
    • NONE — NONE
    • PROCESSING — PROCESSING (default)

  • Default value: PROCESSING

  • Type: int
  • Properties: Filter, Group, Nillable, Sort
  • Introduced: API version 62.0
  • Description: Total number of fields in the DLO.
  • Type: long
  • Properties: Filter, Group, Nillable, Sort
  • Description: Total number of records stored in the DLO.

This object has the following associated objects. If the API version isn’t specified, they’re available in the same API versions as this object. Otherwise, they’re available in the specified API version.