API documentation

• servicex package
  • Subpackages
    • servicex.app package
      • Submodules
      • servicex.app.cache module
      • servicex.app.cli_options module
      • servicex.app.codegen module
      • servicex.app.main module
      • servicex.app.transforms module
      • Module contents
    • servicex.databinder_models
      • ServiceXSpec
      • General
      • Sample
    • servicex.func_adl package
      • Submodules
      • servicex.func_adl.func_adl_dataset module
      • servicex.func_adl.func_adl_dataset_group module
      • servicex.func_adl.util module
      • Module contents
  • Submodules
  • servicex.configuration module
    • Configuration
      • Configuration.api_endpoints
      • Configuration.default_endpoint
      • Configuration.cache_path
      • Configuration.shortened_downloaded_filename
      • Configuration.expand_cache_path
      • Configuration.endpoint_dict()
      • Configuration.read()
    • Endpoint
      • Endpoint.endpoint
      • Endpoint.name
      • Endpoint.token
  • servicex.databinder_models module
    • General
      • General.OutputFormatEnum
      • General.DeliveryEnum
      • General.Codegen
      • General.OutputFormat
      • General.Delivery
      • General.OutputDirectory
      • General.OutFilesetName
    • Sample
      • Sample.Name
      • Sample.Dataset
      • Sample.NFiles
      • Sample.Query
      • Sample.IgnoreLocalCache
      • Sample.Codegen
      • Sample.RucioDID
      • Sample.XRootDFiles
      • Sample.dataset_identifier
      • Sample.validate_did_xor_file
      • Sample.validate_nfiles_is_not_zero
      • Sample.truncate_long_sample_name
      • Sample.hash
    • ServiceXSpec
      • ServiceXSpec.General
      • ServiceXSpec.Sample
      • ServiceXSpec.Definition
      • ServiceXSpec.validate_unique_sample
  • servicex.dataset_group module
    • DatasetGroup
      • DatasetGroup.as_files()
      • DatasetGroup.as_files_async()
      • DatasetGroup.as_signed_urls()
      • DatasetGroup.as_signed_urls_async()
      • DatasetGroup.set_result_format()
  • servicex.dataset_identifier module
    • CERNOpenDataDatasetIdentifier
      • CERNOpenDataDatasetIdentifier.from_yaml()
      • CERNOpenDataDatasetIdentifier.yaml_tag
    • DataSetIdentifier
      • DataSetIdentifier.did
      • DataSetIdentifier.hash
      • DataSetIdentifier.populate_transform_request()
    • FileListDataset
      • FileListDataset.did
      • FileListDataset.files
      • FileListDataset.from_yaml()
      • FileListDataset.hash
      • FileListDataset.num_files
      • FileListDataset.populate_transform_request()
      • FileListDataset.yaml_tag
    • RucioDatasetIdentifier
      • RucioDatasetIdentifier.from_yaml()
      • RucioDatasetIdentifier.yaml_tag
    • XRootDDatasetIdentifier
      • XRootDDatasetIdentifier.from_yaml()
      • XRootDDatasetIdentifier.yaml_tag
  • servicex.expandable_progress module
    • ExpandableProgress
      • ExpandableProgress.add_task()
      • ExpandableProgress.advance()
      • ExpandableProgress.refresh()
      • ExpandableProgress.start_task()
      • ExpandableProgress.update()
    • ProgressCounts
    • TranformStatusProgress
      • TranformStatusProgress.get_renderables()
  • servicex.minio_adapter module
    • MinioAdapter
      • MinioAdapter.MAX_PATH_LEN
      • MinioAdapter.download_file()
      • MinioAdapter.for_transform()
      • MinioAdapter.get_signed_url()
      • MinioAdapter.hash_path()
      • MinioAdapter.list_bucket()
  • servicex.models module
    • CachedDataset
      • CachedDataset.id
      • CachedDataset.name
      • CachedDataset.did_finder
      • CachedDataset.n_files
      • CachedDataset.size
      • CachedDataset.events
      • CachedDataset.last_used
      • CachedDataset.last_updated
      • CachedDataset.lookup_status
      • CachedDataset.is_stale
      • CachedDataset.files
    • DatasetFile
      • DatasetFile.id
      • DatasetFile.adler32
      • DatasetFile.file_size
      • DatasetFile.file_events
      • DatasetFile.paths
    • DocStringBaseModel
    • ResultDestination
      • ResultDestination.object_store
      • ResultDestination.volume
    • ResultFile
      • ResultFile.filename
      • ResultFile.size
      • ResultFile.extension
    • ResultFormat
      • ResultFormat.parquet
      • ResultFormat.root_ttree
    • Status
      • Status.canceled
      • Status.complete
      • Status.fatal
      • Status.looking
      • Status.pending
      • Status.running
      • Status.submitted
    • TransformRequest
      • TransformRequest.title
      • TransformRequest.did
      • TransformRequest.file_list
      • TransformRequest.selection
      • TransformRequest.image
      • TransformRequest.codegen
      • TransformRequest.tree_name
      • TransformRequest.result_destination
      • TransformRequest.result_format
      • TransformRequest.compute_hash()
    • TransformStatus
      • TransformStatus.request_id
      • TransformStatus.did
      • TransformStatus.title
      • TransformStatus.selection
      • TransformStatus.tree_name
      • TransformStatus.image
      • TransformStatus.result_destination
      • TransformStatus.result_format
      • TransformStatus.generated_code_cm
      • TransformStatus.status
      • TransformStatus.app_version
      • TransformStatus.files
      • TransformStatus.files_completed
      • TransformStatus.files_failed
      • TransformStatus.files_remaining
      • TransformStatus.submit_time
      • TransformStatus.finish_time
      • TransformStatus.minio_endpoint
      • TransformStatus.minio_secured
      • TransformStatus.minio_access_key
      • TransformStatus.minio_secret_key
      • TransformStatus.log_url
      • TransformStatus.parse_finish_time
    • TransformedResults
      • TransformedResults.hash
      • TransformedResults.title
      • TransformedResults.codegen
      • TransformedResults.request_id
      • TransformedResults.submit_time
      • TransformedResults.data_dir
      • TransformedResults.file_list
      • TransformedResults.signed_url_list
      • TransformedResults.files
      • TransformedResults.result_format
      • TransformedResults.log_url
  • servicex.python_dataset module
    • PythonFunction
      • PythonFunction.default_codegen
      • PythonFunction.from_yaml()
      • PythonFunction.generate_selection_string()
      • PythonFunction.with_uproot_function()
      • PythonFunction.yaml_tag
  • servicex.query module
  • servicex.query_cache module
    • CacheException
    • QueryCache
      • QueryCache.cache_path_for_transform()
      • QueryCache.cache_transform()
      • QueryCache.cached_queries()
      • QueryCache.close()
      • QueryCache.contains_hash()
      • QueryCache.delete_codegen_by_backend()
      • QueryCache.delete_record_by_hash()
      • QueryCache.delete_record_by_request_id()
      • QueryCache.get_codegen_by_backend()
      • QueryCache.get_transform_by_hash()
      • QueryCache.get_transform_by_request_id()
      • QueryCache.get_transform_request_id()
      • QueryCache.is_transform_request_submitted()
      • QueryCache.transformed_results()
      • QueryCache.update_codegen_by_backend()
      • QueryCache.update_record()
      • QueryCache.update_transform_request_id()
      • QueryCache.update_transform_status()
  • servicex.servicex_adapter module
    • AuthorizationError
    • ServiceXAdapter
      • ServiceXAdapter.delete_dataset()
      • ServiceXAdapter.get_code_generators()
      • ServiceXAdapter.get_dataset()
      • ServiceXAdapter.get_datasets()
      • ServiceXAdapter.get_transform_status()
      • ServiceXAdapter.get_transforms()
      • ServiceXAdapter.submit_transform()
  • servicex.servicex_client module
    • GuardList
      • GuardList.valid()
    • ReturnValueException
    • ServiceXClient
      • ServiceXClient.delete_dataset()
      • ServiceXClient.generic_query()
      • ServiceXClient.get_code_generators()
      • ServiceXClient.get_dataset()
      • ServiceXClient.get_datasets()
      • ServiceXClient.get_transform_status()
      • ServiceXClient.get_transform_status_async()
      • ServiceXClient.get_transforms()
      • ServiceXClient.get_transforms_async()
    • deliver()
  • servicex.types module
  • Module contents
    • Delivery
    • General
      • General.OutputFormatEnum
      • General.DeliveryEnum
      • General.Codegen
      • General.OutputFormat
      • General.Delivery
      • General.OutputDirectory
      • General.OutFilesetName
    • OutputFormat
    • ResultDestination
      • ResultDestination.object_store
      • ResultDestination.volume
    • Sample
      • Sample.Name
      • Sample.Dataset
      • Sample.NFiles
      • Sample.Query
      • Sample.IgnoreLocalCache
      • Sample.Codegen
      • Sample.RucioDID
      • Sample.XRootDFiles
      • Sample.dataset_identifier
      • Sample.validate_did_xor_file
      • Sample.validate_nfiles_is_not_zero
      • Sample.truncate_long_sample_name
      • Sample.hash
    • ServiceXSpec
      • ServiceXSpec.General
      • ServiceXSpec.Sample
      • ServiceXSpec.Definition
      • ServiceXSpec.validate_unique_sample
    • deliver()