foundry_dev_tools.clients package

The Foundry DevTools API clients.

Submodules

• foundry_dev_tools.clients.api_client module
  • APIClient
    • APIClient.api_name
    • APIClient.__init__()
    • APIClient.api_url()
    • APIClient.api_request()
  • PublicAPIClient
    • PublicAPIClient.api_name
    • PublicAPIClient.__init__()
    • PublicAPIClient.api_url()
    • PublicAPIClient.api_request()
• foundry_dev_tools.clients.build2 module
  • Build2Client
    • Build2Client.api_name
    • Build2Client.api_get_build_report()
    • Build2Client.api_get_job_report()
    • Build2Client.api_submit_build()
    • Build2Client.submit_dataset_build()
    • Build2Client.api_get_jobspec_for_dataset()
    • Build2Client.api_remove_jobspecs()
• foundry_dev_tools.clients.catalog module
  • CatalogClient
    • CatalogClient.api_name
    • CatalogClient.list_dataset_files()
    • CatalogClient.api_get_dataset_view_files3()
    • CatalogClient.api_get_events()
    • CatalogClient.api_create_dataset()
    • CatalogClient.api_get_dataset()
    • CatalogClient.api_delete_dataset()
    • CatalogClient.api_set_transaction_type()
    • CatalogClient.api_start_transaction()
    • CatalogClient.api_commit_transaction()
    • CatalogClient.api_abort_transaction()
    • CatalogClient.api_get_transaction()
    • CatalogClient.api_get_reverse_transactions2()
    • CatalogClient.api_create_branch()
    • CatalogClient.api_update_branch()
    • CatalogClient.api_get_branch()
    • CatalogClient.api_get_branches()
    • CatalogClient.api_remove_dataset_file()
    • CatalogClient.api_add_files_to_delete_transaction()
    • CatalogClient.api_get_dataset_stats()
• foundry_dev_tools.clients.compass module
  • get_decoration()
  • CompassClient
    • CompassClient.api_name
    • CompassClient.api_get_resource()
    • CompassClient.api_get_resource_by_path()
    • CompassClient.api_check_name()
    • CompassClient.api_add_to_trash()
    • CompassClient.api_restore()
    • CompassClient.api_delete_permanently()
    • CompassClient.api_create_folder()
    • CompassClient.api_get_path()
    • CompassClient.api_get_paths()
    • CompassClient.get_paths()
    • CompassClient.get_path()
    • CompassClient.api_get_parent()
    • CompassClient.api_get_children()
    • CompassClient.get_child_objects_of_folder()
    • CompassClient.api_move_children()
    • CompassClient.api_get_resources()
    • CompassClient.api_process_marking()
    • CompassClient.add_marking()
    • CompassClient.remove_marking()
    • CompassClient.api_add_imports()
    • CompassClient.api_remove_imports()
    • CompassClient.api_get_imports()
    • CompassClient.get_imports()
    • CompassClient.get_dangling_imports()
    • CompassClient.api_set_name()
    • CompassClient.api_resources_exist()
    • CompassClient.resources_exist()
    • CompassClient.resource_exists()
    • CompassClient.api_get_projects_by_rids()
    • CompassClient.get_projects_by_rids()
    • CompassClient.get_project_by_rid()
    • CompassClient.api_resolve_path()
    • CompassClient.api_search_projects()
    • CompassClient.search_projects()
    • CompassClient.api_get_resource_roles()
    • CompassClient.get_resource_roles()
    • CompassClient.api_update_project_roles()
    • CompassClient.api_update_resource_roles()
    • CompassClient.api_get_home_folder()
    • CompassClient.api_get_decorated_organization_and_project_information()
    • CompassClient.api_get_all_namespace_rids()
• foundry_dev_tools.clients.context_client module
  • retry()
  • ContextHTTPClient
    • ContextHTTPClient.__init__()
    • ContextHTTPClient.request()
• foundry_dev_tools.clients.data_proxy module
  • DataProxyClient
    • DataProxyClient.api_name
    • DataProxyClient.upload_dataset_file()
    • DataProxyClient.upload_dataset_files()
    • DataProxyClient.query_foundry_sql_legacy()
    • DataProxyClient.download_dataset_file()
    • DataProxyClient.download_dataset_files()
    • DataProxyClient.api_put_file()
    • DataProxyClient.api_get_file()
    • DataProxyClient.api_get_file_in_view()
    • DataProxyClient.api_get_files()
    • DataProxyClient.api_get_files_in_view()
    • DataProxyClient.api_get_dataset_as_csv2()
    • DataProxyClient.api_query_with_fallbacks2()
• foundry_dev_tools.clients.foundry_sql_server module
  • FoundrySqlServerClient
    • FoundrySqlServerClient.api_name
    • FoundrySqlServerClient.query_foundry_sql()
    • FoundrySqlServerClient.read_fsql_query_results_arrow()
    • FoundrySqlServerClient.api_queries_execute()
    • FoundrySqlServerClient.api_queries_status()
    • FoundrySqlServerClient.api_queries_results()
• foundry_dev_tools.clients.foundry_stats module
  • FoundryStatsClient
    • FoundryStatsClient.api_name
    • FoundryStatsClient.api_foundry_stats()
• foundry_dev_tools.clients.jemma module
  • JemmaClient
    • JemmaClient.api_name
    • JemmaClient.start_checks_and_builds()
    • JemmaClient.api_post_build_jobs()
• foundry_dev_tools.clients.magritte_coordinator module
  • MagritteCoordinatorClient
    • MagritteCoordinatorClient.api_name
    • MagritteCoordinatorClient.api_get_oidc_metadata()
    • MagritteCoordinatorClient.get_oidc_issuer()
    • MagritteCoordinatorClient.api_add_source_v3()
    • MagritteCoordinatorClient.api_update_source_v2()
    • MagritteCoordinatorClient.create_s3_direct_source()
    • MagritteCoordinatorClient.api_delete_extract()
    • MagritteCoordinatorClient.get_source_config()
    • MagritteCoordinatorClient.api_bulk_get_source_config()
    • MagritteCoordinatorClient.get_source_description()
    • MagritteCoordinatorClient.api_bulk_get_source_description()
    • MagritteCoordinatorClient.api_add_extract_for_branch()
    • MagritteCoordinatorClient.create_new_extract_for_source()
    • MagritteCoordinatorClient.api_get_runtime_platform()
    • MagritteCoordinatorClient.set_network_egress_policies()
    • MagritteCoordinatorClient.get_network_egress_policies()
    • MagritteCoordinatorClient.add_network_egress_policy()
    • MagritteCoordinatorClient.delete_network_egress_policy()
    • MagritteCoordinatorClient.enable_s3_oidc_runtime()
    • MagritteCoordinatorClient.disable_s3_oidc_runtime()
    • MagritteCoordinatorClient.api_modify_source_usage_restrictions()
    • MagritteCoordinatorClient.enable_code_imports()
    • MagritteCoordinatorClient.restrict_code_imports()
    • MagritteCoordinatorClient.api_bulk_get_usage_restrictions_for_source()
    • MagritteCoordinatorClient.api_get_export_state_for_source()
    • MagritteCoordinatorClient.api_update_export_state_for_source()
    • MagritteCoordinatorClient.api_add_exportable_markings_for_source()
    • MagritteCoordinatorClient.api_remove_exportable_markings_for_source()
    • MagritteCoordinatorClient.create_snowflake_source()
    • MagritteCoordinatorClient.enable_snowflake_external_oauth()
    • MagritteCoordinatorClient.disable_snowflake_external_oauth()
• foundry_dev_tools.clients.metadata module
  • MetadataClient
    • MetadataClient.api_name
    • MetadataClient.api_upload_dataset_schema()
    • MetadataClient.api_get_dataset_schema()
• foundry_dev_tools.clients.multipass module
  • DEFAULT_TOKEN_LIFETIME_IN_SECONDS
  • MINIMUM_MAX_DURATION_IN_SECONDS
  • DEFAULT_MAX_DURATION_IN_SECONDS
  • MultipassClient
    • MultipassClient.api_name
    • MultipassClient.get_user_info()
    • MultipassClient.api_me()
    • MultipassClient.search()
    • MultipassClient.api_get_groups_of_user()
    • MultipassClient.is_member_of_group()
    • MultipassClient.api_get_principals()
    • MultipassClient.api_create_group()
    • MultipassClient.api_get_group()
    • MultipassClient.api_update_group()
    • MultipassClient.api_rename_group()
    • MultipassClient.api_delete_group()
    • MultipassClient.api_delete_user()
    • MultipassClient.api_get_group_manager_managers()
    • MultipassClient.api_get_group_member_managers()
    • MultipassClient.api_update_group_managers()
    • MultipassClient.add_group_manager_managers()
    • MultipassClient.add_group_member_managers()
    • MultipassClient.remove_group_manager_managers()
    • MultipassClient.remove_group_member_managers()
    • MultipassClient.api_add_group_members()
    • MultipassClient.api_get_principals_groups_all()
    • MultipassClient.api_get_immediate_group_members()
    • MultipassClient.api_get_all_group_members()
    • MultipassClient.api_get_all_group_users()
    • MultipassClient.api_remove_group_members()
    • MultipassClient.api_get_group_member_expirations()
    • MultipassClient.api_get_group_member_expiration_settings()
    • MultipassClient.api_update_group_member_expiration_settings()
    • MultipassClient.reset_group_member_expiration_settings()
    • MultipassClient.api_get_all_organizations()
    • MultipassClient.api_create_third_party_application()
    • MultipassClient.api_delete_third_party_application()
    • MultipassClient.api_update_third_party_application()
    • MultipassClient.api_rotate_third_party_application_secret()
    • MultipassClient.api_enable_third_party_application()
    • MultipassClient.api_create_token()
    • MultipassClient.api_revoke_token()
    • MultipassClient.api_get_tokens()
    • MultipassClient.get_tokens()
    • MultipassClient.api_get_ttl()
• foundry_dev_tools.clients.public_ontologies_client module
  • OntologiesClient
    • OntologiesClient.api_name
    • OntologiesClient.api_list_ontologies()
    • OntologiesClient.list()
    • OntologiesClient.api_get_ontology()
    • OntologiesClient.get()
• foundry_dev_tools.clients.s3_client module
  • S3Client
    • S3Client.__init__()
    • S3Client.get_url()
    • S3Client.get_s3fs_storage_options()
    • S3Client.get_polars_storage_options()
    • S3Client.get_duckdb_create_secret_string()
    • S3Client.get_boto3_client()
    • S3Client.get_boto3_resource()
    • S3Client.get_credentials()
    • S3Client.api_assume_role_with_webidentity()
• foundry_dev_tools.clients.scheduler module
  • SchedulerClient
    • SchedulerClient.api_name
    • SchedulerClient.get_schedules_by_run_build()
    • SchedulerClient.get_schedule()
• foundry_dev_tools.clients.schema_inference module
  • SchemaInferenceClient
    • SchemaInferenceClient.api_name
    • SchemaInferenceClient.infer_dataset_schema()
    • SchemaInferenceClient.api_infer_dataset_schema()
• foundry_dev_tools.clients.tables module
  • TablesClient
    • TablesClient.api_name
    • TablesClient.api_create_table()
    • TablesClient.create_glue_table()
    • TablesClient.create_snowflake_table()
    • TablesClient.api_list_tables()
    • TablesClient.list_tables()
    • TablesClient.api_get_table_schema()