# SalesforceObjectDescription (/docs/codegen/api/interfaces/SalesforceObjectDescription)



[@kysoql/codegen](/docs/codegen/api) / SalesforceObjectDescription

Salesforce object metadata consumed by the schema renderer.

## Properties [#properties]

| Property                                                         | Modifier   | Type                                                                                                                        | Description                                                                   |
| ---------------------------------------------------------------- | ---------- | --------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------- |
| <a id="api-property-bigobjectindex" /> `bigObjectIndex?`         | `readonly` | readonly `string`\[]                                                                                                        | Ordered Big Object index field names, when the object is a custom Big Object. |
| <a id="api-property-fieldscomplete" /> `fieldsComplete?`         | `readonly` | `boolean`                                                                                                                   | Codegen annotation, not a Salesforce Describe property. Omission means full.  |
| <a id="api-property-name" /> `name`                              | `readonly` | `string`                                                                                                                    | Salesforce object API name.                                                   |
| <a id="api-property-fields" /> `fields`                          | `readonly` | readonly [`SalesforceFieldDescription`](/docs/codegen/api/interfaces/SalesforceFieldDescription)\[]                         | Validated field metadata used to render the object schema.                    |
| <a id="api-property-mruenabled" /> `mruEnabled?`                 | `readonly` | `boolean`                                                                                                                   | Whether Salesforce reports MRU support for the object.                        |
| <a id="api-property-childrelationships" /> `childRelationships?` | `readonly` | readonly [`SalesforceChildRelationshipDescription`](/docs/codegen/api/interfaces/SalesforceChildRelationshipDescription)\[] | Child relationships available for SOQL relationship subqueries.               |
| <a id="api-property-supportedscopes" /> `supportedScopes?`       | `readonly` | readonly [`SalesforceSupportedScopeDescription`](/docs/codegen/api/interfaces/SalesforceSupportedScopeDescription)\[]       | `USING SCOPE` values reported by Salesforce.                                  |
| <a id="api-property-datacategorygroups" /> `dataCategoryGroups?` | `readonly` | readonly [`SalesforceDataCategoryGroupDescription`](/docs/codegen/api/interfaces/SalesforceDataCategoryGroupDescription)\[] | Flattened data-category metadata attached to the generated object schema.     |