Files

class zos_files.zowe.zos_files_for_zowe_sdk.Files(connection: dict[str, Any], log: bool = True)

Class used to represent the base z/OSMF Files API.

A Datasets class object

Type:: Datasets

uss

An USSFiles class object

Type:: USSFiles

A FileSystems class object

Type:: FileSystems

Parameters:

connection (dict[str, Any]) – The z/OSMF connection object (generated by the ZoweSDK object)
log (bool) – Flag to disable logger

copy_data_set_or_member(from_dataset_name: str, to_dataset_name: str, from_member_name: str | None = None, volser: str | None = None, alias: bool | None = None, to_member_name: str | None = None, enq: str | None = None, replace: bool = False) → None: Use ds.copy_data_set_or_member() instead of this deprecated function.

copy_uss_to_data_set(from_filename: str, to_dataset_name: str, to_member_name: str | None = None, type: FileType = FileType.TEXT, replace: bool = False) → None: Use ds.copy_uss_to_data_set() instead of this deprecated function.

create_data_set(dataset_name: str, options: DatasetOption | None = None) → None: Use ds.create() instead of this deprecated function.

create_default_data_set(dataset_name: str, default_type: str) → None: Use ds.create_default() instead of this deprecated function.

create_uss(file_path: str, file_type: str, mode: str | None = None) → None: Use uss.create() instead of this deprecated function.

create_zfs_file_system(file_system_name: str, options: dict[str, Any] | None = None) → None: Use fs.create() instead of this deprecated function.

delete_data_set(dataset_name: str, volume: str | None = None, member_name: str | None = None) → None: Use ds.delete() instead of this deprecated function.

delete_migrated_data_set(dataset_name: str, purge: bool = False, wait: bool = False) → None: Use ds.delete_migrated() instead of this deprecated function.

delete_uss(filepath_name: str, recursive: bool = False) → None: Use uss.delete() instead of this deprecated function.

delete_zfs_file_system(file_system_name: str) → None: Use fs.delete() instead of this deprecated function.

download_binary_dsn(dataset_name: str, output_file: str, with_prefixes: bool = False) → None: Use ds.perform_download(content_type=ContentType.BINARY) instead of this deprecated function.

download_dsn(dataset_name: str, output_file: str) → None: Use ds.perform_download() instead of this deprecated function.

download_uss(file_path: str, output_file: str, binary: bool = False) → None: Use uss.perform_download() instead of this deprecated function.

get_dsn_binary_content(dataset_name: str, with_prefixes: bool = False) → bytes: Use ds.retrieve_content(content_type=ContentType.BINARY) instead of this deprecated function.

get_dsn_binary_content_streamed(dataset_name: str, with_prefixes: bool = False) → Response

Get binary content from the provided data set as a streamed Response.

This function is deprecated. Use ds.retrieve_content(content_type=ContentType.BINARY, as_stream=True) instead.

get_dsn_content(dataset_name: str) → str | None: Use ds.get_content() instead of this deprecated function.

get_dsn_content_streamed(dataset_name: str) → Response: Use ds.retrieve_content(as_stream=True) instead of this deprecated function.

get_file_content(filepath_name: str) → str | None: Use uss.retrieve_content() instead of this deprecated function.

get_file_content_streamed(file_path: str, binary: bool = False) → Response: Use uss.retrieve_content(as_stream=True) instead of this deprecated function.

list_dsn(name_pattern: str, return_attributes: bool = False) → DatasetListResponse: Use ds.list() instead of this deprecated function.

list_dsn_members(dataset_name: str, member_pattern: str | None = None, member_start: str | None = None, limit: int = 1000, attributes: str = 'member') → MemberListResponse: Use ds.list_members() instead of this deprecated function.

list_files(path: str) → Any: Use uss.list() instead of this deprecated function.

list_unix_file_systems(file_path_name: str | None = None, file_system_name: str | None = None) → FileSystemListResponse: Use fs.list() instead of this deprecated function.

migrate_data_set(dataset_name: str, wait: bool = False) → None: Use ds.migrate() instead of this deprecated function.

mount_file_system(file_system_name: str, mount_point: str, options: dict[str, Any] = {}, encoding: str = 'utf-8') → None: Use fs.mount() instead of this deprecated function.

recall_migrated_data_set(dataset_name: str, wait: bool = False) → None: Use ds.recall_migrated() instead of this deprecated function.

rename_data_set(before_dataset_name: str, after_dataset_name: str) → None: Use ds.rename() instead of this deprecated function.

rename_data_set_member(dataset_name: str, before_member_name: str, after_member_name: str, enq: str = '') → None: Use ds.rename_member() instead of this deprecated function.

unmount_file_system(file_system_name: str, options: dict[str, Any] | None = None, encoding: str = 'utf-8') → None: Use fs.unmount() instead of this deprecated function.

upload_file_to_dsn(input_file: str, dataset_name: str, encoding: str = 'utf-8', binary: bool = False) → None: Use ds.perform_upload() instead of this deprecated function.

upload_file_to_uss(input_file: str, filepath_name: str, encoding: str = 'utf-8') → None: Use uss.perform_upload() instead of this deprecated function.

write_to_dsn(dataset_name: str, data: str | bytes, encoding: str = 'utf-8') → None: Use ds.write() instead of this deprecated function.

write_to_uss(filepath_name: str, data: str, encoding: str = 'utf-8') → None: Use uss.write() instead of this deprecated function.