Salesforce

Salesforce

pyatlan.model.assets.salesforce.Salesforce(__pydantic_self__, **data: Any)

Bases: SaaS

Description

Source code in pyatlan/model/assets/core/referenceable.py

def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

API_NAME: KeywordTextField = KeywordTextField('apiName', 'apiName.keyword', 'apiName') class-attribute

Name of this asset in the Salesforce API.

ORGANIZATION_QUALIFIED_NAME: TextField = TextField('organizationQualifiedName', 'organizationQualifiedName') class-attribute

Fully-qualified name of the organization in Salesforce.

SalesforceObject

pyatlan.model.assets.salesforce_object.SalesforceObject(__pydantic_self__, **data: Any)

Bases: Salesforce

Description

Source code in pyatlan/model/assets/core/referenceable.py

def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

FIELDS: RelationField = RelationField('fields') class-attribute

TBC

FIELD_COUNT: NumericField = NumericField('fieldCount', 'fieldCount') class-attribute

Number of fields in this object.

IS_CUSTOM: BooleanField = BooleanField('isCustom', 'isCustom') class-attribute

Whether this object is a custom object (true) or not (false).

IS_MERGABLE: BooleanField = BooleanField('isMergable', 'isMergable') class-attribute

Whether this object is mergable (true) or not (false).

IS_QUERYABLE: BooleanField = BooleanField('isQueryable', 'isQueryable') class-attribute

Whether this object is queryable (true) or not (false).

LOOKUP_FIELDS: RelationField = RelationField('lookupFields') class-attribute

TBC

ORGANIZATION: RelationField = RelationField('organization') class-attribute

TBC

SalesforceField

pyatlan.model.assets.salesforce_field.SalesforceField(__pydantic_self__, **data: Any)

Bases: Salesforce

Description

Source code in pyatlan/model/assets/core/referenceable.py

def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

DATA_TYPE: KeywordTextField = KeywordTextField('dataType', 'dataType', 'dataType.text') class-attribute

Data type of values in this field.

DEFAULT_VALUE_FORMULA: TextField = TextField('defaultValueFormula', 'defaultValueFormula') class-attribute

Formula for the default value for this field.

FORMULA: TextField = TextField('formula', 'formula') class-attribute

Formula for this field, if it is a calculated field.

INLINE_HELP_TEXT: TextField = TextField('inlineHelpText', 'inlineHelpText.text') class-attribute

Help text for this field.

IS_CALCULATED: BooleanField = BooleanField('isCalculated', 'isCalculated') class-attribute

Whether this field is calculated (true) or not (false).

IS_CASE_SENSITIVE: BooleanField = BooleanField('isCaseSensitive', 'isCaseSensitive') class-attribute

Whether this field is case sensitive (true) or in-sensitive (false).

IS_ENCRYPTED: BooleanField = BooleanField('isEncrypted', 'isEncrypted') class-attribute

Whether this field is encrypted (true) or not (false).

IS_NULLABLE: BooleanField = BooleanField('isNullable', 'isNullable') class-attribute

Whether this field allows null values (true) or not (false).

IS_POLYMORPHIC_FOREIGN_KEY: BooleanField = BooleanField('isPolymorphicForeignKey', 'isPolymorphicForeignKey') class-attribute

Whether this field references a record of multiple objects (true) or not (false).

IS_UNIQUE: BooleanField = BooleanField('isUnique', 'isUnique') class-attribute

Whether this field must have unique values (true) or not (false).

LOOKUP_OBJECTS: RelationField = RelationField('lookupObjects') class-attribute

TBC

MAX_LENGTH: NumericField = NumericField('maxLength', 'maxLength') class-attribute

Maximum length of this field.

NUMERIC_SCALE: NumericField = NumericField('numericScale', 'numericScale') class-attribute

Number of digits allowed to the right of the decimal point.

OBJECT: RelationField = RelationField('object') class-attribute

TBC

OBJECT_QUALIFIED_NAME: KeywordField = KeywordField('objectQualifiedName', 'objectQualifiedName') class-attribute

Unique name of the object in which this field exists.

ORDER: NumericField = NumericField('order', 'order') class-attribute

Order (position) of this field within the object.

PICKLIST_VALUES: TextField = TextField('picklistValues', 'picklistValues') class-attribute

List of values from which a user can pick while adding a record.

PRECISION: NumericField = NumericField('precision', 'precision') class-attribute

Total number of digits allowed.

SalesforceOrganization

pyatlan.model.assets.salesforce_organization.SalesforceOrganization(__pydantic_self__, **data: Any)

Bases: Salesforce

Description

Source code in pyatlan/model/assets/core/referenceable.py

def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

DASHBOARDS: RelationField = RelationField('dashboards') class-attribute

TBC

OBJECTS: RelationField = RelationField('objects') class-attribute

TBC

REPORTS: RelationField = RelationField('reports') class-attribute

TBC

SOURCE_ID: TextField = TextField('sourceId', 'sourceId') class-attribute

Identifier of the organization in Salesforce.

SalesforceDashboard

pyatlan.model.assets.salesforce_dashboard.SalesforceDashboard(__pydantic_self__, **data: Any)

Bases: Salesforce

Description

Source code in pyatlan/model/assets/core/referenceable.py

def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

DASHBOARD_TYPE: TextField = TextField('dashboardType', 'dashboardType') class-attribute

Type of dashboard in Salesforce.

ORGANIZATION: RelationField = RelationField('organization') class-attribute

TBC

REPORTS: RelationField = RelationField('reports') class-attribute

TBC

REPORT_COUNT: NumericField = NumericField('reportCount', 'reportCount') class-attribute

Number of reports linked to the dashboard in Salesforce.

SOURCE_ID: TextField = TextField('sourceId', 'sourceId') class-attribute

Identifier of the dashboard in Salesforce.

SalesforceReport

pyatlan.model.assets.salesforce_report.SalesforceReport(__pydantic_self__, **data: Any)

Bases: Salesforce

Description

Source code in pyatlan/model/assets/core/referenceable.py

def __init__(__pydantic_self__, **data: Any) -> None:
    super().__init__(**data)
    __pydantic_self__.__fields_set__.update(["attributes", "type_name"])

Attributes

DASHBOARDS: RelationField = RelationField('dashboards') class-attribute

TBC

DETAIL_COLUMNS: KeywordField = KeywordField('detailColumns', 'detailColumns') class-attribute

List of column names on the report.

ORGANIZATION: RelationField = RelationField('organization') class-attribute

TBC

REPORT_TYPE: KeywordField = KeywordField('reportType', 'reportType') class-attribute

Type of report in Salesforce.

SOURCE_ID: TextField = TextField('sourceId', 'sourceId') class-attribute

Identifier of the report in Salesforce.