adp.ingest.dataclasses.SMBSourceConfig

class adp.ingest.dataclasses.SMBSourceConfig(*, spark_read_options: Dict[str, Any] | None = None, file_read_settings: Dict[str, Any] | None = None, adls_file_pattern: str = '*', adls_file_anti_pattern: str | None = None, zip_password: str | None = None, raise_no_files_found_exception: bool | None = False, staging_path: str | None = None, username: str, password: str, root: str, smb_file_pattern: str = '*', auth_protocol: Literal['negotiate', 'ntlm', 'kerberos'] = 'ntlm', domain_controller: str | None = 'INS.LOCAL', remove_source_files: bool | None = False, read_subfolders: bool = False)
__init__(**data: Any) None

Create a new model by parsing and validating input data from keyword arguments.

Raises [ValidationError][pydantic_core.ValidationError] if the input data cannot be validated to form a valid model.

self is explicitly positional-only to allow self as a field name.

Methods

__init__(**data)

Create a new model by parsing and validating input data from keyword arguments.

construct([_fields_set])

copy(*[, include, exclude, update, deep])

Returns a copy of the model.

dict(*[, include, exclude, by_alias, ...])

from_orm(obj)

json(*[, include, exclude, by_alias, ...])

model_construct([_fields_set])

Creates a new instance of the Model class with validated data.

model_copy(*[, update, deep])

!!! abstract "Usage Documentation"

model_dump(*[, mode, include, exclude, ...])

!!! abstract "Usage Documentation"

model_dump_json(*[, indent, ensure_ascii, ...])

!!! abstract "Usage Documentation"

model_json_schema(by_alias, ref_template, ...)

Generates a JSON schema for a model class.

model_parametrized_name(params)

Compute the class name for parametrizations of generic classes.

model_post_init(context, /)

Override this method to perform additional initialization after __init__ and model_construct.

model_rebuild(*[, force, raise_errors, ...])

Try to rebuild the pydantic-core schema for the model.

model_validate(obj, *[, strict, extra, ...])

Validate a pydantic model instance.

model_validate_json(json_data, *[, strict, ...])

!!! abstract "Usage Documentation"

model_validate_strings(obj, *[, strict, ...])

Validate the given object with string data against the Pydantic model.

parse_file(path, *[, content_type, ...])

parse_obj(obj)

parse_raw(b, *[, content_type, encoding, ...])

schema([by_alias, ref_template])

schema_json(*[, by_alias, ref_template])

update_forward_refs(**localns)

validate(value)

validate_auth_protocol(auth_protocol)

Lowercase auth_protocol.

Attributes

model_computed_fields

model_config

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

model_extra

Get extra fields set during validation.

model_fields

model_fields_set

Returns the set of fields that have been explicitly set on this model instance.

server

Returns part of the config.root that starts with \ and the first time it sees either a BACKSLASH

username

password

root

smb_file_pattern

auth_protocol

domain_controller

remove_source_files

read_subfolders

file_read_settings

spark_read_options

adls_file_pattern

adls_file_anti_pattern

zip_password

raise_no_files_found_exception

staging_path

model_config = {}

Configuration for the model, should be a dictionary conforming to [ConfigDict][pydantic.config.ConfigDict].

property server: str

Returns part of the config.root that starts with \ and the first time it sees either a BACKSLASH

classmethod validate_auth_protocol(auth_protocol: str) str

Lowercase auth_protocol.