SalesforceObjectDescription

@kysoql/codegen / SalesforceObjectDescription

Salesforce object metadata consumed by the schema renderer.

Properties

Property	Modifier	Type	Description
`bigObjectIndex?`	`readonly`	readonly `string`[]	Ordered Big Object index field names, when the object is a custom Big Object.
`fieldsComplete?`	`readonly`	`boolean`	Codegen annotation, not a Salesforce Describe property. Omission means full.
`name`	`readonly`	`string`	Salesforce object API name.
`fields`	`readonly`	readonly `SalesforceFieldDescription`[]	Validated field metadata used to render the object schema.
`mruEnabled?`	`readonly`	`boolean`	Whether Salesforce reports MRU support for the object.
`childRelationships?`	`readonly`	readonly `SalesforceChildRelationshipDescription`[]	Child relationships available for SOQL relationship subqueries.
`supportedScopes?`	`readonly`	readonly `SalesforceSupportedScopeDescription`[]	`USING SCOPE` values reported by Salesforce.
`dataCategoryGroups?`	`readonly`	readonly `SalesforceDataCategoryGroupDescription`[]	Flattened data-category metadata attached to the generated object schema.