From fcd56034d14477edf3a7e60d47812e77103d3d93 Mon Sep 17 00:00:00 2001 From: Excavator Bot <33266368+svc-excavator-bot@users.noreply.github.com> Date: Thu, 28 Nov 2024 09:27:59 -0800 Subject: [PATCH] Excavator: Upgrade API Version (#77) --- .gitignore | 3 - README.md | 87 +++++- .../models/CreateInterfaceObjectRule.md | 1 + .../models/CreateInterfaceObjectRuleDict.md | 1 + .../models/DeleteInterfaceObjectRule.md | 12 + .../models/DeleteInterfaceObjectRuleDict.md | 12 + .../ontologies/models/InterfaceTypeApiName.md | 13 + docs/v1/ontologies/models/LogicRule.md | 1 + docs/v1/ontologies/models/LogicRuleDict.md | 1 + .../models/ModifyInterfaceObjectRule.md | 1 + .../models/ModifyInterfaceObjectRuleDict.md | 1 + docs/v1/ontologies/models/PropertyValue.md | 36 +-- docs/v2/Admin/Group.md | 12 +- docs/v2/Connectivity/Connection.md | 13 +- docs/v2/Connectivity/FileImport.md | 98 ++++++- docs/v2/Connectivity/TableImport.md | 258 ++++++++++++++++++ docs/v2/Datasets/Dataset.md | 4 +- docs/v2/Orchestration/Build.md | 65 ++++- docs/v2/Orchestration/Schedule.md | 2 + docs/v2/Streams/Dataset.md | 6 +- docs/v2/Streams/Stream.md | 28 +- docs/v2/connectivity/models/CloudIdentity.md | 14 + .../connectivity/models/CloudIdentityDict.md | 14 + .../connectivity/models/CloudIdentityRid.md | 12 + docs/v2/connectivity/models/Connection.md | 1 + docs/v2/connectivity/models/ConnectionDict.md | 1 + ...eTableImportRequestJdbcImportConfigDict.md | 12 + ...tRequestMicrosoftAccessImportConfigDict.md | 12 + ...questMicrosoftSqlServerImportConfigDict.md | 12 + ...ableImportRequestOracleImportConfigDict.md | 12 + ...ImportRequestPostgreSqlImportConfigDict.md | 12 + ...TableImportRequestTableImportConfigDict.md | 20 ++ .../connectivity/models/JdbcImportConfig.md | 13 + .../models/JdbcImportConfigDict.md | 13 + .../models/MicrosoftAccessImportConfig.md | 13 + .../models/MicrosoftAccessImportConfigDict.md | 13 + .../models/MicrosoftSqlServerImportConfig.md | 13 + .../MicrosoftSqlServerImportConfigDict.md | 13 + docs/v2/connectivity/models/Oidc.md | 16 ++ docs/v2/connectivity/models/OidcDict.md | 16 ++ .../connectivity/models/OracleImportConfig.md | 13 + .../models/OracleImportConfigDict.md | 13 + .../models/PostgreSqlImportConfig.md | 13 + .../models/PostgreSqlImportConfigDict.md | 13 + .../models/S3AuthenticationMode.md | 14 +- .../models/S3AuthenticationModeDict.md | 14 +- docs/v2/connectivity/models/TableImport.md | 17 ++ .../connectivity/models/TableImportConfig.md | 20 ++ .../models/TableImportConfigDict.md | 20 ++ .../v2/connectivity/models/TableImportDict.md | 17 ++ .../models/TableImportDisplayName.md | 11 + .../v2/connectivity/models/TableImportMode.md | 15 + docs/v2/connectivity/models/TableImportRid.md | 12 + docs/v2/core/models/FilePath.md | 2 +- docs/v2/core/models/TimeseriesType.md | 2 +- docs/v2/core/models/TimeseriesTypeDict.md | 2 +- .../ontologies/models/ActionParameterType.md | 10 +- .../models/ActionParameterTypeDict.md | 10 +- .../models/ActivePropertyTypeStatus.md | 13 + .../models/ActivePropertyTypeStatusDict.md | 13 + .../models/CreateInterfaceObjectRule.md | 1 + .../models/CreateInterfaceObjectRuleDict.md | 1 + .../models/DeleteInterfaceObjectRule.md | 12 + .../models/DeleteInterfaceObjectRuleDict.md | 12 + .../models/DeprecatedPropertyTypeStatus.md | 16 ++ .../DeprecatedPropertyTypeStatusDict.md | 16 ++ .../models/ExamplePropertyTypeStatus.md | 13 + .../models/ExamplePropertyTypeStatusDict.md | 13 + .../models/ExperimentalPropertyTypeStatus.md | 11 + .../ExperimentalPropertyTypeStatusDict.md | 11 + docs/v2/ontologies/models/LogicRule.md | 1 + docs/v2/ontologies/models/LogicRuleDict.md | 1 + .../models/ModifyInterfaceObjectRule.md | 1 + .../models/ModifyInterfaceObjectRuleDict.md | 1 + .../models/OntologyInterfaceObjectType.md | 12 + .../models/OntologyInterfaceObjectTypeDict.md | 12 + .../models/OntologyObjectTypeReferenceType.md | 11 + .../OntologyObjectTypeReferenceTypeDict.md | 11 + .../ontologies/models/PropertyTypeStatus.md | 19 ++ .../models/PropertyTypeStatusDict.md | 19 ++ .../models/PropertyTypeVisibility.md | 12 + docs/v2/ontologies/models/PropertyV2.md | 2 + docs/v2/ontologies/models/PropertyV2Dict.md | 2 + docs/v2/orchestration/models/Build.md | 2 +- docs/v2/orchestration/models/BuildDict.md | 2 +- docs/v2/orchestration/models/BuildRid.md | 2 +- .../models/CreateScheduleRequestActionDict.md | 2 +- ...> CreateScheduleRequestBuildTargetDict.md} | 8 +- ...ateScheduleRequestConnectingTargetDict.md} | 4 +- ... CreateScheduleRequestManualTargetDict.md} | 4 +- ... CreateScheduleRequestProjectScopeDict.md} | 4 +- .../CreateScheduleRequestScopeModeDict.md | 4 +- ...reateScheduleRequestUpstreamTargetDict.md} | 4 +- ... => CreateScheduleRequestUserScopeDict.md} | 4 +- .../models/NotificationsEnabled.md | 3 +- .../ReplaceScheduleRequestActionDict.md | 2 +- ... ReplaceScheduleRequestBuildTargetDict.md} | 8 +- ...aceScheduleRequestConnectingTargetDict.md} | 4 +- ...ReplaceScheduleRequestManualTargetDict.md} | 4 +- ...ReplaceScheduleRequestProjectScopeDict.md} | 4 +- .../ReplaceScheduleRequestScopeModeDict.md | 4 +- ...placeScheduleRequestUpstreamTargetDict.md} | 4 +- ...=> ReplaceScheduleRequestUserScopeDict.md} | 4 +- foundry/_versions.py | 2 +- foundry/v1/cli.py | 5 + foundry/v1/mediasets/models/__init__.py | 16 ++ foundry/v1/ontologies/models/__init__.py | 10 + .../models/_create_interface_object_rule.py | 3 + .../_create_interface_object_rule_dict.py | 4 + .../models/_delete_interface_object_rule.py | 42 +++ .../_delete_interface_object_rule_dict.py | 32 +++ .../models/_interface_type_api_name.py | 24 ++ foundry/v1/ontologies/models/_logic_rule.py | 4 + .../v1/ontologies/models/_logic_rule_dict.py | 4 + .../models/_modify_interface_object_rule.py | 3 + .../_modify_interface_object_rule_dict.py | 4 + .../v1/ontologies/models/_property_value.py | 36 +-- foundry/v2/cli.py | 218 ++++++++++++++- foundry/v2/connectivity/connection.py | 11 + foundry/v2/connectivity/file_import.py | 81 ++++++ foundry/v2/connectivity/models/__init__.py | 78 ++++++ .../v2/connectivity/models/_cloud_identity.py | 41 +++ .../models/_cloud_identity_dict.py | 35 +++ .../models/_cloud_identity_rid.py | 21 ++ foundry/v2/connectivity/models/_connection.py | 3 + .../connectivity/models/_connection_dict.py | 3 + ..._import_request_jdbc_import_config_dict.py | 36 +++ ...est_microsoft_access_import_config_dict.py | 36 +++ ...microsoft_sql_server_import_config_dict.py | 36 +++ ...mport_request_oracle_import_config_dict.py | 36 +++ ..._request_postgre_sql_import_config_dict.py | 36 +++ ...import_request_table_import_config_dict.py | 49 ++++ .../models/_jdbc_import_config.py | 42 +++ .../models/_jdbc_import_config_dict.py | 36 +++ .../models/_microsoft_access_import_config.py | 46 ++++ .../_microsoft_access_import_config_dict.py | 36 +++ .../_microsoft_sql_server_import_config.py | 46 ++++ ...microsoft_sql_server_import_config_dict.py | 36 +++ foundry/v2/connectivity/models/_oidc.py | 48 ++++ foundry/v2/connectivity/models/_oidc_dict.py | 43 +++ .../models/_oracle_import_config.py | 42 +++ .../models/_oracle_import_config_dict.py | 36 +++ .../models/_postgre_sql_import_config.py | 44 +++ .../models/_postgre_sql_import_config_dict.py | 36 +++ .../models/_s3_authentication_mode.py | 11 +- .../models/_s3_authentication_mode_dict.py | 11 +- .../v2/connectivity/models/_table_import.py | 57 ++++ .../models/_table_import_config.py | 43 +++ .../models/_table_import_config_dict.py | 45 +++ .../connectivity/models/_table_import_dict.py | 50 ++++ .../models/_table_import_display_name.py | 21 ++ .../connectivity/models/_table_import_mode.py | 26 ++ .../connectivity/models/_table_import_rid.py | 21 ++ foundry/v2/connectivity/table_import.py | 256 +++++++++++++++++ foundry/v2/core/models/_file_path.py | 2 +- foundry/v2/core/models/_timeseries_type.py | 3 +- .../v2/core/models/_timeseries_type_dict.py | 3 +- foundry/v2/datasets/dataset.py | 2 +- foundry/v2/mediasets/models/__init__.py | 16 ++ .../models/_action_parameter_type.py | 16 +- .../models/_action_parameter_type_dict.py | 16 +- .../models/_active_property_type_status.py | 42 +++ .../_active_property_type_status_dict.py | 31 +++ .../models/_create_interface_object_rule.py | 3 + .../_create_interface_object_rule_dict.py | 4 + .../models/_delete_interface_object_rule.py | 42 +++ .../_delete_interface_object_rule_dict.py | 32 +++ .../_deprecated_property_type_status.py | 51 ++++ .../_deprecated_property_type_status_dict.py | 42 +++ .../models/_example_property_type_status.py | 42 +++ .../_example_property_type_status_dict.py | 31 +++ .../_experimental_property_type_status.py | 39 +++ ..._experimental_property_type_status_dict.py | 28 ++ foundry/v2/ontologies/models/_logic_rule.py | 4 + .../v2/ontologies/models/_logic_rule_dict.py | 4 + .../models/_modify_interface_object_rule.py | 3 + .../_modify_interface_object_rule_dict.py | 4 + .../models/_ontology_interface_object_type.py | 42 +++ .../_ontology_interface_object_type_dict.py | 32 +++ .../_ontology_object_type_reference_type.py | 39 +++ ...ntology_object_type_reference_type_dict.py | 28 ++ .../models/_property_type_status.py | 45 +++ .../models/_property_type_status_dict.py | 45 +++ .../models/_property_type_visibility.py | 21 ++ foundry/v2/ontologies/models/_property_v2.py | 6 + .../v2/ontologies/models/_property_v2_dict.py | 6 + foundry/v2/orchestration/build.py | 42 ++- foundry/v2/orchestration/models/__init__.py | 80 +++--- foundry/v2/orchestration/models/_build.py | 2 +- .../v2/orchestration/models/_build_dict.py | 2 +- foundry/v2/orchestration/models/_build_rid.py | 2 +- .../_create_schedule_request_action_dict.py | 6 +- ...ate_schedule_request_build_target_dict.py} | 20 +- ...chedule_request_connecting_target_dict.py} | 4 +- ...te_schedule_request_manual_target_dict.py} | 4 +- ...te_schedule_request_project_scope_dict.py} | 4 +- ...create_schedule_request_scope_mode_dict.py | 12 +- ..._schedule_request_upstream_target_dict.py} | 4 +- ...reate_schedule_request_user_scope_dict.py} | 4 +- .../models/_notifications_enabled.py | 5 +- .../_replace_schedule_request_action_dict.py | 6 +- ...ace_schedule_request_build_target_dict.py} | 20 +- ...chedule_request_connecting_target_dict.py} | 4 +- ...ce_schedule_request_manual_target_dict.py} | 4 +- ...ce_schedule_request_project_scope_dict.py} | 4 +- ...eplace_schedule_request_scope_mode_dict.py | 13 +- ..._schedule_request_upstream_target_dict.py} | 4 +- ...place_schedule_request_user_scope_dict.py} | 4 +- tests/test_discriminators.py | 4 + 209 files changed, 4088 insertions(+), 249 deletions(-) create mode 100644 docs/v1/ontologies/models/DeleteInterfaceObjectRule.md create mode 100644 docs/v1/ontologies/models/DeleteInterfaceObjectRuleDict.md create mode 100644 docs/v1/ontologies/models/InterfaceTypeApiName.md create mode 100644 docs/v2/Connectivity/TableImport.md create mode 100644 docs/v2/connectivity/models/CloudIdentity.md create mode 100644 docs/v2/connectivity/models/CloudIdentityDict.md create mode 100644 docs/v2/connectivity/models/CloudIdentityRid.md create mode 100644 docs/v2/connectivity/models/CreateTableImportRequestJdbcImportConfigDict.md create mode 100644 docs/v2/connectivity/models/CreateTableImportRequestMicrosoftAccessImportConfigDict.md create mode 100644 docs/v2/connectivity/models/CreateTableImportRequestMicrosoftSqlServerImportConfigDict.md create mode 100644 docs/v2/connectivity/models/CreateTableImportRequestOracleImportConfigDict.md create mode 100644 docs/v2/connectivity/models/CreateTableImportRequestPostgreSqlImportConfigDict.md create mode 100644 docs/v2/connectivity/models/CreateTableImportRequestTableImportConfigDict.md create mode 100644 docs/v2/connectivity/models/JdbcImportConfig.md create mode 100644 docs/v2/connectivity/models/JdbcImportConfigDict.md create mode 100644 docs/v2/connectivity/models/MicrosoftAccessImportConfig.md create mode 100644 docs/v2/connectivity/models/MicrosoftAccessImportConfigDict.md create mode 100644 docs/v2/connectivity/models/MicrosoftSqlServerImportConfig.md create mode 100644 docs/v2/connectivity/models/MicrosoftSqlServerImportConfigDict.md create mode 100644 docs/v2/connectivity/models/Oidc.md create mode 100644 docs/v2/connectivity/models/OidcDict.md create mode 100644 docs/v2/connectivity/models/OracleImportConfig.md create mode 100644 docs/v2/connectivity/models/OracleImportConfigDict.md create mode 100644 docs/v2/connectivity/models/PostgreSqlImportConfig.md create mode 100644 docs/v2/connectivity/models/PostgreSqlImportConfigDict.md create mode 100644 docs/v2/connectivity/models/TableImport.md create mode 100644 docs/v2/connectivity/models/TableImportConfig.md create mode 100644 docs/v2/connectivity/models/TableImportConfigDict.md create mode 100644 docs/v2/connectivity/models/TableImportDict.md create mode 100644 docs/v2/connectivity/models/TableImportDisplayName.md create mode 100644 docs/v2/connectivity/models/TableImportMode.md create mode 100644 docs/v2/connectivity/models/TableImportRid.md create mode 100644 docs/v2/ontologies/models/ActivePropertyTypeStatus.md create mode 100644 docs/v2/ontologies/models/ActivePropertyTypeStatusDict.md create mode 100644 docs/v2/ontologies/models/DeleteInterfaceObjectRule.md create mode 100644 docs/v2/ontologies/models/DeleteInterfaceObjectRuleDict.md create mode 100644 docs/v2/ontologies/models/DeprecatedPropertyTypeStatus.md create mode 100644 docs/v2/ontologies/models/DeprecatedPropertyTypeStatusDict.md create mode 100644 docs/v2/ontologies/models/ExamplePropertyTypeStatus.md create mode 100644 docs/v2/ontologies/models/ExamplePropertyTypeStatusDict.md create mode 100644 docs/v2/ontologies/models/ExperimentalPropertyTypeStatus.md create mode 100644 docs/v2/ontologies/models/ExperimentalPropertyTypeStatusDict.md create mode 100644 docs/v2/ontologies/models/OntologyInterfaceObjectType.md create mode 100644 docs/v2/ontologies/models/OntologyInterfaceObjectTypeDict.md create mode 100644 docs/v2/ontologies/models/OntologyObjectTypeReferenceType.md create mode 100644 docs/v2/ontologies/models/OntologyObjectTypeReferenceTypeDict.md create mode 100644 docs/v2/ontologies/models/PropertyTypeStatus.md create mode 100644 docs/v2/ontologies/models/PropertyTypeStatusDict.md create mode 100644 docs/v2/ontologies/models/PropertyTypeVisibility.md rename docs/v2/orchestration/models/{CreateScheduleRequestActionBuildTargetDict.md => CreateScheduleRequestBuildTargetDict.md} (63%) rename docs/v2/orchestration/models/{CreateScheduleRequestActionBuildTargetConnectingTargetDict.md => CreateScheduleRequestConnectingTargetDict.md} (84%) rename docs/v2/orchestration/models/{CreateScheduleRequestActionBuildTargetManualTargetDict.md => CreateScheduleRequestManualTargetDict.md} (77%) rename docs/v2/orchestration/models/{CreateScheduleRequestScopeModeProjectScopeDict.md => CreateScheduleRequestProjectScopeDict.md} (80%) rename docs/v2/orchestration/models/{CreateScheduleRequestActionBuildTargetUpstreamTargetDict.md => CreateScheduleRequestUpstreamTargetDict.md} (82%) rename docs/v2/orchestration/models/{CreateScheduleRequestScopeModeUserScopeDict.md => CreateScheduleRequestUserScopeDict.md} (79%) rename docs/v2/orchestration/models/{ReplaceScheduleRequestActionBuildTargetDict.md => ReplaceScheduleRequestBuildTargetDict.md} (63%) rename docs/v2/orchestration/models/{ReplaceScheduleRequestActionBuildTargetConnectingTargetDict.md => ReplaceScheduleRequestConnectingTargetDict.md} (84%) rename docs/v2/orchestration/models/{ReplaceScheduleRequestActionBuildTargetManualTargetDict.md => ReplaceScheduleRequestManualTargetDict.md} (77%) rename docs/v2/orchestration/models/{ReplaceScheduleRequestScopeModeProjectScopeDict.md => ReplaceScheduleRequestProjectScopeDict.md} (79%) rename docs/v2/orchestration/models/{ReplaceScheduleRequestActionBuildTargetUpstreamTargetDict.md => ReplaceScheduleRequestUpstreamTargetDict.md} (82%) rename docs/v2/orchestration/models/{ReplaceScheduleRequestScopeModeUserScopeDict.md => ReplaceScheduleRequestUserScopeDict.md} (78%) create mode 100644 foundry/v1/mediasets/models/__init__.py create mode 100644 foundry/v1/ontologies/models/_delete_interface_object_rule.py create mode 100644 foundry/v1/ontologies/models/_delete_interface_object_rule_dict.py create mode 100644 foundry/v1/ontologies/models/_interface_type_api_name.py create mode 100644 foundry/v2/connectivity/models/_cloud_identity.py create mode 100644 foundry/v2/connectivity/models/_cloud_identity_dict.py create mode 100644 foundry/v2/connectivity/models/_cloud_identity_rid.py create mode 100644 foundry/v2/connectivity/models/_create_table_import_request_jdbc_import_config_dict.py create mode 100644 foundry/v2/connectivity/models/_create_table_import_request_microsoft_access_import_config_dict.py create mode 100644 foundry/v2/connectivity/models/_create_table_import_request_microsoft_sql_server_import_config_dict.py create mode 100644 foundry/v2/connectivity/models/_create_table_import_request_oracle_import_config_dict.py create mode 100644 foundry/v2/connectivity/models/_create_table_import_request_postgre_sql_import_config_dict.py create mode 100644 foundry/v2/connectivity/models/_create_table_import_request_table_import_config_dict.py create mode 100644 foundry/v2/connectivity/models/_jdbc_import_config.py create mode 100644 foundry/v2/connectivity/models/_jdbc_import_config_dict.py create mode 100644 foundry/v2/connectivity/models/_microsoft_access_import_config.py create mode 100644 foundry/v2/connectivity/models/_microsoft_access_import_config_dict.py create mode 100644 foundry/v2/connectivity/models/_microsoft_sql_server_import_config.py create mode 100644 foundry/v2/connectivity/models/_microsoft_sql_server_import_config_dict.py create mode 100644 foundry/v2/connectivity/models/_oidc.py create mode 100644 foundry/v2/connectivity/models/_oidc_dict.py create mode 100644 foundry/v2/connectivity/models/_oracle_import_config.py create mode 100644 foundry/v2/connectivity/models/_oracle_import_config_dict.py create mode 100644 foundry/v2/connectivity/models/_postgre_sql_import_config.py create mode 100644 foundry/v2/connectivity/models/_postgre_sql_import_config_dict.py create mode 100644 foundry/v2/connectivity/models/_table_import.py create mode 100644 foundry/v2/connectivity/models/_table_import_config.py create mode 100644 foundry/v2/connectivity/models/_table_import_config_dict.py create mode 100644 foundry/v2/connectivity/models/_table_import_dict.py create mode 100644 foundry/v2/connectivity/models/_table_import_display_name.py create mode 100644 foundry/v2/connectivity/models/_table_import_mode.py create mode 100644 foundry/v2/connectivity/models/_table_import_rid.py create mode 100644 foundry/v2/connectivity/table_import.py create mode 100644 foundry/v2/mediasets/models/__init__.py create mode 100644 foundry/v2/ontologies/models/_active_property_type_status.py create mode 100644 foundry/v2/ontologies/models/_active_property_type_status_dict.py create mode 100644 foundry/v2/ontologies/models/_delete_interface_object_rule.py create mode 100644 foundry/v2/ontologies/models/_delete_interface_object_rule_dict.py create mode 100644 foundry/v2/ontologies/models/_deprecated_property_type_status.py create mode 100644 foundry/v2/ontologies/models/_deprecated_property_type_status_dict.py create mode 100644 foundry/v2/ontologies/models/_example_property_type_status.py create mode 100644 foundry/v2/ontologies/models/_example_property_type_status_dict.py create mode 100644 foundry/v2/ontologies/models/_experimental_property_type_status.py create mode 100644 foundry/v2/ontologies/models/_experimental_property_type_status_dict.py create mode 100644 foundry/v2/ontologies/models/_ontology_interface_object_type.py create mode 100644 foundry/v2/ontologies/models/_ontology_interface_object_type_dict.py create mode 100644 foundry/v2/ontologies/models/_ontology_object_type_reference_type.py create mode 100644 foundry/v2/ontologies/models/_ontology_object_type_reference_type_dict.py create mode 100644 foundry/v2/ontologies/models/_property_type_status.py create mode 100644 foundry/v2/ontologies/models/_property_type_status_dict.py create mode 100644 foundry/v2/ontologies/models/_property_type_visibility.py rename foundry/v2/orchestration/models/{_create_schedule_request_action_build_target_dict.py => _create_schedule_request_build_target_dict.py} (52%) rename foundry/v2/orchestration/models/{_create_schedule_request_action_build_target_connecting_target_dict.py => _create_schedule_request_connecting_target_dict.py} (89%) rename foundry/v2/orchestration/models/{_create_schedule_request_action_build_target_manual_target_dict.py => _create_schedule_request_manual_target_dict.py} (87%) rename foundry/v2/orchestration/models/{_create_schedule_request_scope_mode_project_scope_dict.py => _create_schedule_request_project_scope_dict.py} (88%) rename foundry/v2/orchestration/models/{_create_schedule_request_action_build_target_upstream_target_dict.py => _create_schedule_request_upstream_target_dict.py} (89%) rename foundry/v2/orchestration/models/{_create_schedule_request_scope_mode_user_scope_dict.py => _create_schedule_request_user_scope_dict.py} (87%) rename foundry/v2/orchestration/models/{_replace_schedule_request_action_build_target_dict.py => _replace_schedule_request_build_target_dict.py} (51%) rename foundry/v2/orchestration/models/{_replace_schedule_request_action_build_target_connecting_target_dict.py => _replace_schedule_request_connecting_target_dict.py} (89%) rename foundry/v2/orchestration/models/{_replace_schedule_request_action_build_target_manual_target_dict.py => _replace_schedule_request_manual_target_dict.py} (87%) rename foundry/v2/orchestration/models/{_replace_schedule_request_scope_mode_project_scope_dict.py => _replace_schedule_request_project_scope_dict.py} (88%) rename foundry/v2/orchestration/models/{_replace_schedule_request_action_build_target_upstream_target_dict.py => _replace_schedule_request_upstream_target_dict.py} (89%) rename foundry/v2/orchestration/models/{_replace_schedule_request_scope_mode_user_scope_dict.py => _replace_schedule_request_user_scope_dict.py} (87%) diff --git a/.gitignore b/.gitignore index 406f318d..3604ea77 100644 --- a/.gitignore +++ b/.gitignore @@ -1,6 +1,3 @@ **/__pycache__ *.pyc tmp - -# IntelliJ -.idea/ diff --git a/README.md b/README.md index f5cebfdc..f20843d1 100644 --- a/README.md +++ b/README.md @@ -350,6 +350,13 @@ Namespace | Resource | Operation | HTTP request | **AipAgents** | Session | [**page**](docs/v2/AipAgents/Session.md#page) | **GET** /v2/aipAgents/agents/{agentRid}/sessions | **AipAgents** | Session | [**rag_context**](docs/v2/AipAgents/Session.md#rag_context) | **PUT** /v2/aipAgents/agents/{agentRid}/sessions/{sessionRid}/ragContext | **AipAgents** | Session | [**streaming_continue**](docs/v2/AipAgents/Session.md#streaming_continue) | **POST** /v2/aipAgents/agents/{agentRid}/sessions/{sessionRid}/streamingContinue | +**Connectivity** | Connection | [**update_secrets**](docs/v2/Connectivity/Connection.md#update_secrets) | **POST** /v2/connectivity/connections/{connectionRid}/updateSecrets | +**Connectivity** | FileImport | [**create**](docs/v2/Connectivity/FileImport.md#create) | **POST** /v2/connectivity/connections/{connectionRid}/fileImports | +**Connectivity** | FileImport | [**delete**](docs/v2/Connectivity/FileImport.md#delete) | **DELETE** /v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid} | +**Connectivity** | FileImport | [**execute**](docs/v2/Connectivity/FileImport.md#execute) | **POST** /v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid}/execute | +**Connectivity** | FileImport | [**get**](docs/v2/Connectivity/FileImport.md#get) | **GET** /v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid} | +**Connectivity** | FileImport | [**list**](docs/v2/Connectivity/FileImport.md#list) | **GET** /v2/connectivity/connections/{connectionRid}/fileImports | +**Connectivity** | FileImport | [**page**](docs/v2/Connectivity/FileImport.md#page) | **GET** /v2/connectivity/connections/{connectionRid}/fileImports | **Datasets** | Branch | [**create**](docs/v2/Datasets/Branch.md#create) | **POST** /v2/datasets/{datasetRid}/branches | **Datasets** | Branch | [**delete**](docs/v2/Datasets/Branch.md#delete) | **DELETE** /v2/datasets/{datasetRid}/branches/{branchName} | **Datasets** | Branch | [**get**](docs/v2/Datasets/Branch.md#get) | **GET** /v2/datasets/{datasetRid}/branches/{branchName} | @@ -408,6 +415,7 @@ Namespace | Resource | Operation | HTTP request | **OntologiesV2** | TimeSeriesPropertyV2 | [**get_first_point**](docs/v2/OntologiesV2/TimeSeriesPropertyV2.md#get_first_point) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/firstPoint | **OntologiesV2** | TimeSeriesPropertyV2 | [**get_last_point**](docs/v2/OntologiesV2/TimeSeriesPropertyV2.md#get_last_point) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/lastPoint | **OntologiesV2** | TimeSeriesPropertyV2 | [**stream_points**](docs/v2/OntologiesV2/TimeSeriesPropertyV2.md#stream_points) | **POST** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/timeseries/{property}/streamPoints | +**Orchestration** | Build | [**cancel**](docs/v2/Orchestration/Build.md#cancel) | **POST** /v2/orchestration/builds/{buildRid}/cancel | **Orchestration** | Build | [**create**](docs/v2/Orchestration/Build.md#create) | **POST** /v2/orchestration/builds/create | **Orchestration** | Build | [**get**](docs/v2/Orchestration/Build.md#get) | **GET** /v2/orchestration/builds/{buildRid} | **Orchestration** | Schedule | [**create**](docs/v2/Orchestration/Schedule.md#create) | **POST** /v2/orchestration/schedules | @@ -417,6 +425,13 @@ Namespace | Resource | Operation | HTTP request | **Orchestration** | Schedule | [**replace**](docs/v2/Orchestration/Schedule.md#replace) | **PUT** /v2/orchestration/schedules/{scheduleRid} | **Orchestration** | Schedule | [**run**](docs/v2/Orchestration/Schedule.md#run) | **POST** /v2/orchestration/schedules/{scheduleRid}/run | **Orchestration** | Schedule | [**unpause**](docs/v2/Orchestration/Schedule.md#unpause) | **POST** /v2/orchestration/schedules/{scheduleRid}/unpause | +**Streams** | Dataset | [**create**](docs/v2/Streams/Dataset.md#create) | **POST** /v2/streams/datasets/create | +**Streams** | Stream | [**create**](docs/v2/Streams/Stream.md#create) | **POST** /v2/streams/datasets/{datasetRid}/streams | +**Streams** | Stream | [**get**](docs/v2/Streams/Stream.md#get) | **GET** /v2/streams/datasets/{datasetRid}/streams/{streamBranchName} | +**Streams** | Stream | [**publish_binary_record**](docs/v2/Streams/Stream.md#publish_binary_record) | **POST** /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishBinaryRecord | +**Streams** | Stream | [**publish_record**](docs/v2/Streams/Stream.md#publish_record) | **POST** /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecord | +**Streams** | Stream | [**publish_records**](docs/v2/Streams/Stream.md#publish_records) | **POST** /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecords | +**Streams** | Stream | [**reset**](docs/v2/Streams/Stream.md#reset) | **POST** /v2/streams/datasets/{datasetRid}/streams/{streamBranchName}/reset | **ThirdPartyApplications** | Version | [**delete**](docs/v2/ThirdPartyApplications/Version.md#delete) | **DELETE** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion} | **ThirdPartyApplications** | Version | [**get**](docs/v2/ThirdPartyApplications/Version.md#get) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions/{versionVersion} | **ThirdPartyApplications** | Version | [**list**](docs/v2/ThirdPartyApplications/Version.md#list) | **GET** /v2/thirdPartyApplications/{thirdPartyApplicationRid}/website/versions | @@ -614,12 +629,21 @@ Namespace | Resource | Operation | HTTP request | - [AsSecretNameDict](docs/v2/models/AsSecretNameDict.md) - [AwsAccessKey](docs/v2/models/AwsAccessKey.md) - [AwsAccessKeyDict](docs/v2/models/AwsAccessKeyDict.md) +- [CloudIdentity](docs/v2/models/CloudIdentity.md) +- [CloudIdentityDict](docs/v2/models/CloudIdentityDict.md) +- [CloudIdentityRid](docs/v2/models/CloudIdentityRid.md) - [Connection](docs/v2/models/Connection.md) - [ConnectionConfiguration](docs/v2/models/ConnectionConfiguration.md) - [ConnectionConfigurationDict](docs/v2/models/ConnectionConfigurationDict.md) - [ConnectionDict](docs/v2/models/ConnectionDict.md) - [ConnectionDisplayName](docs/v2/models/ConnectionDisplayName.md) - [ConnectionRid](docs/v2/models/ConnectionRid.md) +- [CreateTableImportRequestJdbcImportConfigDict](docs/v2/models/CreateTableImportRequestJdbcImportConfigDict.md) +- [CreateTableImportRequestMicrosoftAccessImportConfigDict](docs/v2/models/CreateTableImportRequestMicrosoftAccessImportConfigDict.md) +- [CreateTableImportRequestMicrosoftSqlServerImportConfigDict](docs/v2/models/CreateTableImportRequestMicrosoftSqlServerImportConfigDict.md) +- [CreateTableImportRequestOracleImportConfigDict](docs/v2/models/CreateTableImportRequestOracleImportConfigDict.md) +- [CreateTableImportRequestPostgreSqlImportConfigDict](docs/v2/models/CreateTableImportRequestPostgreSqlImportConfigDict.md) +- [CreateTableImportRequestTableImportConfigDict](docs/v2/models/CreateTableImportRequestTableImportConfigDict.md) - [DirectConnectionRuntime](docs/v2/models/DirectConnectionRuntime.md) - [DirectConnectionRuntimeDict](docs/v2/models/DirectConnectionRuntimeDict.md) - [EncryptedProperty](docs/v2/models/EncryptedProperty.md) @@ -650,10 +674,22 @@ Namespace | Resource | Operation | HTTP request | - [FilesCountLimitFilterDict](docs/v2/models/FilesCountLimitFilterDict.md) - [FileSizeFilter](docs/v2/models/FileSizeFilter.md) - [FileSizeFilterDict](docs/v2/models/FileSizeFilterDict.md) +- [JdbcImportConfig](docs/v2/models/JdbcImportConfig.md) +- [JdbcImportConfigDict](docs/v2/models/JdbcImportConfigDict.md) - [ListFileImportsResponse](docs/v2/models/ListFileImportsResponse.md) - [ListFileImportsResponseDict](docs/v2/models/ListFileImportsResponseDict.md) +- [MicrosoftAccessImportConfig](docs/v2/models/MicrosoftAccessImportConfig.md) +- [MicrosoftAccessImportConfigDict](docs/v2/models/MicrosoftAccessImportConfigDict.md) +- [MicrosoftSqlServerImportConfig](docs/v2/models/MicrosoftSqlServerImportConfig.md) +- [MicrosoftSqlServerImportConfigDict](docs/v2/models/MicrosoftSqlServerImportConfigDict.md) - [NetworkEgressPolicyRid](docs/v2/models/NetworkEgressPolicyRid.md) +- [Oidc](docs/v2/models/Oidc.md) +- [OidcDict](docs/v2/models/OidcDict.md) +- [OracleImportConfig](docs/v2/models/OracleImportConfig.md) +- [OracleImportConfigDict](docs/v2/models/OracleImportConfigDict.md) - [PlaintextValue](docs/v2/models/PlaintextValue.md) +- [PostgreSqlImportConfig](docs/v2/models/PostgreSqlImportConfig.md) +- [PostgreSqlImportConfigDict](docs/v2/models/PostgreSqlImportConfigDict.md) - [RuntimePlatform](docs/v2/models/RuntimePlatform.md) - [RuntimePlatformDict](docs/v2/models/RuntimePlatformDict.md) - [S3AuthenticationMode](docs/v2/models/S3AuthenticationMode.md) @@ -661,6 +697,13 @@ Namespace | Resource | Operation | HTTP request | - [S3ConnectionConfiguration](docs/v2/models/S3ConnectionConfiguration.md) - [S3ConnectionConfigurationDict](docs/v2/models/S3ConnectionConfigurationDict.md) - [SecretName](docs/v2/models/SecretName.md) +- [TableImport](docs/v2/models/TableImport.md) +- [TableImportConfig](docs/v2/models/TableImportConfig.md) +- [TableImportConfigDict](docs/v2/models/TableImportConfigDict.md) +- [TableImportDict](docs/v2/models/TableImportDict.md) +- [TableImportDisplayName](docs/v2/models/TableImportDisplayName.md) +- [TableImportMode](docs/v2/models/TableImportMode.md) +- [TableImportRid](docs/v2/models/TableImportRid.md) - [ArrayFieldType](docs/v2/models/ArrayFieldType.md) - [ArrayFieldTypeDict](docs/v2/models/ArrayFieldTypeDict.md) - [AttachmentType](docs/v2/models/AttachmentType.md) @@ -904,6 +947,8 @@ Namespace | Resource | Operation | HTTP request | - [ActionTypeRid](docs/v2/models/ActionTypeRid.md) - [ActionTypeV2](docs/v2/models/ActionTypeV2.md) - [ActionTypeV2Dict](docs/v2/models/ActionTypeV2Dict.md) +- [ActivePropertyTypeStatus](docs/v2/models/ActivePropertyTypeStatus.md) +- [ActivePropertyTypeStatusDict](docs/v2/models/ActivePropertyTypeStatusDict.md) - [AddLink](docs/v2/models/AddLink.md) - [AddLinkDict](docs/v2/models/AddLinkDict.md) - [AddObject](docs/v2/models/AddObject.md) @@ -975,10 +1020,14 @@ Namespace | Resource | Operation | HTTP request | - [CreateTemporaryObjectSetResponseV2](docs/v2/models/CreateTemporaryObjectSetResponseV2.md) - [CreateTemporaryObjectSetResponseV2Dict](docs/v2/models/CreateTemporaryObjectSetResponseV2Dict.md) - [DataValue](docs/v2/models/DataValue.md) +- [DeleteInterfaceObjectRule](docs/v2/models/DeleteInterfaceObjectRule.md) +- [DeleteInterfaceObjectRuleDict](docs/v2/models/DeleteInterfaceObjectRuleDict.md) - [DeleteLinkRule](docs/v2/models/DeleteLinkRule.md) - [DeleteLinkRuleDict](docs/v2/models/DeleteLinkRuleDict.md) - [DeleteObjectRule](docs/v2/models/DeleteObjectRule.md) - [DeleteObjectRuleDict](docs/v2/models/DeleteObjectRuleDict.md) +- [DeprecatedPropertyTypeStatus](docs/v2/models/DeprecatedPropertyTypeStatus.md) +- [DeprecatedPropertyTypeStatusDict](docs/v2/models/DeprecatedPropertyTypeStatusDict.md) - [DoesNotIntersectBoundingBoxQuery](docs/v2/models/DoesNotIntersectBoundingBoxQuery.md) - [DoesNotIntersectBoundingBoxQueryDict](docs/v2/models/DoesNotIntersectBoundingBoxQueryDict.md) - [DoesNotIntersectPolygonQuery](docs/v2/models/DoesNotIntersectPolygonQuery.md) @@ -986,8 +1035,12 @@ Namespace | Resource | Operation | HTTP request | - [EqualsQueryV2](docs/v2/models/EqualsQueryV2.md) - [EqualsQueryV2Dict](docs/v2/models/EqualsQueryV2Dict.md) - [ExactDistinctAggregationV2Dict](docs/v2/models/ExactDistinctAggregationV2Dict.md) +- [ExamplePropertyTypeStatus](docs/v2/models/ExamplePropertyTypeStatus.md) +- [ExamplePropertyTypeStatusDict](docs/v2/models/ExamplePropertyTypeStatusDict.md) - [ExecuteQueryResponse](docs/v2/models/ExecuteQueryResponse.md) - [ExecuteQueryResponseDict](docs/v2/models/ExecuteQueryResponseDict.md) +- [ExperimentalPropertyTypeStatus](docs/v2/models/ExperimentalPropertyTypeStatus.md) +- [ExperimentalPropertyTypeStatusDict](docs/v2/models/ExperimentalPropertyTypeStatusDict.md) - [FunctionRid](docs/v2/models/FunctionRid.md) - [FunctionVersion](docs/v2/models/FunctionVersion.md) - [FuzzyV2](docs/v2/models/FuzzyV2.md) @@ -1111,12 +1164,16 @@ Namespace | Resource | Operation | HTTP request | - [OntologyFullMetadata](docs/v2/models/OntologyFullMetadata.md) - [OntologyFullMetadataDict](docs/v2/models/OntologyFullMetadataDict.md) - [OntologyIdentifier](docs/v2/models/OntologyIdentifier.md) +- [OntologyInterfaceObjectType](docs/v2/models/OntologyInterfaceObjectType.md) +- [OntologyInterfaceObjectTypeDict](docs/v2/models/OntologyInterfaceObjectTypeDict.md) - [OntologyObjectArrayType](docs/v2/models/OntologyObjectArrayType.md) - [OntologyObjectArrayTypeDict](docs/v2/models/OntologyObjectArrayTypeDict.md) - [OntologyObjectSetType](docs/v2/models/OntologyObjectSetType.md) - [OntologyObjectSetTypeDict](docs/v2/models/OntologyObjectSetTypeDict.md) - [OntologyObjectType](docs/v2/models/OntologyObjectType.md) - [OntologyObjectTypeDict](docs/v2/models/OntologyObjectTypeDict.md) +- [OntologyObjectTypeReferenceType](docs/v2/models/OntologyObjectTypeReferenceType.md) +- [OntologyObjectTypeReferenceTypeDict](docs/v2/models/OntologyObjectTypeReferenceTypeDict.md) - [OntologyObjectV2](docs/v2/models/OntologyObjectV2.md) - [OntologyRid](docs/v2/models/OntologyRid.md) - [OntologyV2](docs/v2/models/OntologyV2.md) @@ -1136,6 +1193,9 @@ Namespace | Resource | Operation | HTTP request | - [PolygonValueDict](docs/v2/models/PolygonValueDict.md) - [PropertyApiName](docs/v2/models/PropertyApiName.md) - [PropertyTypeRid](docs/v2/models/PropertyTypeRid.md) +- [PropertyTypeStatus](docs/v2/models/PropertyTypeStatus.md) +- [PropertyTypeStatusDict](docs/v2/models/PropertyTypeStatusDict.md) +- [PropertyTypeVisibility](docs/v2/models/PropertyTypeVisibility.md) - [PropertyV2](docs/v2/models/PropertyV2.md) - [PropertyV2Dict](docs/v2/models/PropertyV2Dict.md) - [PropertyValue](docs/v2/models/PropertyValue.md) @@ -1229,14 +1289,14 @@ Namespace | Resource | Operation | HTTP request | - [BuildTargetDict](docs/v2/models/BuildTargetDict.md) - [ConnectingTarget](docs/v2/models/ConnectingTarget.md) - [ConnectingTargetDict](docs/v2/models/ConnectingTargetDict.md) -- [CreateScheduleRequestActionBuildTargetConnectingTargetDict](docs/v2/models/CreateScheduleRequestActionBuildTargetConnectingTargetDict.md) -- [CreateScheduleRequestActionBuildTargetDict](docs/v2/models/CreateScheduleRequestActionBuildTargetDict.md) -- [CreateScheduleRequestActionBuildTargetManualTargetDict](docs/v2/models/CreateScheduleRequestActionBuildTargetManualTargetDict.md) -- [CreateScheduleRequestActionBuildTargetUpstreamTargetDict](docs/v2/models/CreateScheduleRequestActionBuildTargetUpstreamTargetDict.md) - [CreateScheduleRequestActionDict](docs/v2/models/CreateScheduleRequestActionDict.md) +- [CreateScheduleRequestBuildTargetDict](docs/v2/models/CreateScheduleRequestBuildTargetDict.md) +- [CreateScheduleRequestConnectingTargetDict](docs/v2/models/CreateScheduleRequestConnectingTargetDict.md) +- [CreateScheduleRequestManualTargetDict](docs/v2/models/CreateScheduleRequestManualTargetDict.md) +- [CreateScheduleRequestProjectScopeDict](docs/v2/models/CreateScheduleRequestProjectScopeDict.md) - [CreateScheduleRequestScopeModeDict](docs/v2/models/CreateScheduleRequestScopeModeDict.md) -- [CreateScheduleRequestScopeModeProjectScopeDict](docs/v2/models/CreateScheduleRequestScopeModeProjectScopeDict.md) -- [CreateScheduleRequestScopeModeUserScopeDict](docs/v2/models/CreateScheduleRequestScopeModeUserScopeDict.md) +- [CreateScheduleRequestUpstreamTargetDict](docs/v2/models/CreateScheduleRequestUpstreamTargetDict.md) +- [CreateScheduleRequestUserScopeDict](docs/v2/models/CreateScheduleRequestUserScopeDict.md) - [CronExpression](docs/v2/models/CronExpression.md) - [DatasetUpdatedTrigger](docs/v2/models/DatasetUpdatedTrigger.md) - [DatasetUpdatedTriggerDict](docs/v2/models/DatasetUpdatedTriggerDict.md) @@ -1255,14 +1315,14 @@ Namespace | Resource | Operation | HTTP request | - [OrTriggerDict](docs/v2/models/OrTriggerDict.md) - [ProjectScope](docs/v2/models/ProjectScope.md) - [ProjectScopeDict](docs/v2/models/ProjectScopeDict.md) -- [ReplaceScheduleRequestActionBuildTargetConnectingTargetDict](docs/v2/models/ReplaceScheduleRequestActionBuildTargetConnectingTargetDict.md) -- [ReplaceScheduleRequestActionBuildTargetDict](docs/v2/models/ReplaceScheduleRequestActionBuildTargetDict.md) -- [ReplaceScheduleRequestActionBuildTargetManualTargetDict](docs/v2/models/ReplaceScheduleRequestActionBuildTargetManualTargetDict.md) -- [ReplaceScheduleRequestActionBuildTargetUpstreamTargetDict](docs/v2/models/ReplaceScheduleRequestActionBuildTargetUpstreamTargetDict.md) - [ReplaceScheduleRequestActionDict](docs/v2/models/ReplaceScheduleRequestActionDict.md) +- [ReplaceScheduleRequestBuildTargetDict](docs/v2/models/ReplaceScheduleRequestBuildTargetDict.md) +- [ReplaceScheduleRequestConnectingTargetDict](docs/v2/models/ReplaceScheduleRequestConnectingTargetDict.md) +- [ReplaceScheduleRequestManualTargetDict](docs/v2/models/ReplaceScheduleRequestManualTargetDict.md) +- [ReplaceScheduleRequestProjectScopeDict](docs/v2/models/ReplaceScheduleRequestProjectScopeDict.md) - [ReplaceScheduleRequestScopeModeDict](docs/v2/models/ReplaceScheduleRequestScopeModeDict.md) -- [ReplaceScheduleRequestScopeModeProjectScopeDict](docs/v2/models/ReplaceScheduleRequestScopeModeProjectScopeDict.md) -- [ReplaceScheduleRequestScopeModeUserScopeDict](docs/v2/models/ReplaceScheduleRequestScopeModeUserScopeDict.md) +- [ReplaceScheduleRequestUpstreamTargetDict](docs/v2/models/ReplaceScheduleRequestUpstreamTargetDict.md) +- [ReplaceScheduleRequestUserScopeDict](docs/v2/models/ReplaceScheduleRequestUserScopeDict.md) - [RetryBackoffDuration](docs/v2/models/RetryBackoffDuration.md) - [RetryBackoffDurationDict](docs/v2/models/RetryBackoffDurationDict.md) - [RetryCount](docs/v2/models/RetryCount.md) @@ -1420,6 +1480,8 @@ Namespace | Resource | Operation | HTTP request | - [CreateObjectRule](docs/v1/models/CreateObjectRule.md) - [CreateObjectRuleDict](docs/v1/models/CreateObjectRuleDict.md) - [DataValue](docs/v1/models/DataValue.md) +- [DeleteInterfaceObjectRule](docs/v1/models/DeleteInterfaceObjectRule.md) +- [DeleteInterfaceObjectRuleDict](docs/v1/models/DeleteInterfaceObjectRuleDict.md) - [DeleteLinkRule](docs/v1/models/DeleteLinkRule.md) - [DeleteLinkRuleDict](docs/v1/models/DeleteLinkRuleDict.md) - [DeleteObjectRule](docs/v1/models/DeleteObjectRule.md) @@ -1435,6 +1497,7 @@ Namespace | Resource | Operation | HTTP request | - [GroupMemberConstraintDict](docs/v1/models/GroupMemberConstraintDict.md) - [GteQueryDict](docs/v1/models/GteQueryDict.md) - [GtQueryDict](docs/v1/models/GtQueryDict.md) +- [InterfaceTypeApiName](docs/v1/models/InterfaceTypeApiName.md) - [IsNullQueryDict](docs/v1/models/IsNullQueryDict.md) - [LinkTypeApiName](docs/v1/models/LinkTypeApiName.md) - [LinkTypeSide](docs/v1/models/LinkTypeSide.md) diff --git a/docs/v1/ontologies/models/CreateInterfaceObjectRule.md b/docs/v1/ontologies/models/CreateInterfaceObjectRule.md index 4c39427e..e5b47b17 100644 --- a/docs/v1/ontologies/models/CreateInterfaceObjectRule.md +++ b/docs/v1/ontologies/models/CreateInterfaceObjectRule.md @@ -5,6 +5,7 @@ CreateInterfaceObjectRule ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | +**interface_type_api_name** | InterfaceTypeApiName | Yes | | **type** | Literal["createInterfaceObject"] | Yes | None | diff --git a/docs/v1/ontologies/models/CreateInterfaceObjectRuleDict.md b/docs/v1/ontologies/models/CreateInterfaceObjectRuleDict.md index 72af968e..72942286 100644 --- a/docs/v1/ontologies/models/CreateInterfaceObjectRuleDict.md +++ b/docs/v1/ontologies/models/CreateInterfaceObjectRuleDict.md @@ -5,6 +5,7 @@ CreateInterfaceObjectRule ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | +**interfaceTypeApiName** | InterfaceTypeApiName | Yes | | **type** | Literal["createInterfaceObject"] | Yes | None | diff --git a/docs/v1/ontologies/models/DeleteInterfaceObjectRule.md b/docs/v1/ontologies/models/DeleteInterfaceObjectRule.md new file mode 100644 index 00000000..5e0ef0ec --- /dev/null +++ b/docs/v1/ontologies/models/DeleteInterfaceObjectRule.md @@ -0,0 +1,12 @@ +# DeleteInterfaceObjectRule + +DeleteInterfaceObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**interface_type_api_name** | InterfaceTypeApiName | Yes | | +**type** | Literal["deleteInterfaceObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/DeleteInterfaceObjectRuleDict.md b/docs/v1/ontologies/models/DeleteInterfaceObjectRuleDict.md new file mode 100644 index 00000000..3a17c8d0 --- /dev/null +++ b/docs/v1/ontologies/models/DeleteInterfaceObjectRuleDict.md @@ -0,0 +1,12 @@ +# DeleteInterfaceObjectRuleDict + +DeleteInterfaceObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**interfaceTypeApiName** | InterfaceTypeApiName | Yes | | +**type** | Literal["deleteInterfaceObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/InterfaceTypeApiName.md b/docs/v1/ontologies/models/InterfaceTypeApiName.md new file mode 100644 index 00000000..f07122b8 --- /dev/null +++ b/docs/v1/ontologies/models/InterfaceTypeApiName.md @@ -0,0 +1,13 @@ +# InterfaceTypeApiName + +The name of the interface type in the API in UpperCamelCase format. To find the API name for your interface +type, use the `List interface types` endpoint or check the **Ontology Manager**. + + +## Type +```python +pydantic.StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v1-link) [[Back to API list]](../../../../README.md#apis-v1-link) [[Back to README]](../../../../README.md) diff --git a/docs/v1/ontologies/models/LogicRule.md b/docs/v1/ontologies/models/LogicRule.md index 17ac5a63..48d5f29a 100644 --- a/docs/v1/ontologies/models/LogicRule.md +++ b/docs/v1/ontologies/models/LogicRule.md @@ -9,6 +9,7 @@ This discriminator class uses the `type` field to differentiate between classes. | Class | Value | ------------ | ------------- +DeleteInterfaceObjectRule | deleteInterfaceObject ModifyInterfaceObjectRule | modifyInterfaceObject ModifyObjectRule | modifyObject DeleteObjectRule | deleteObject diff --git a/docs/v1/ontologies/models/LogicRuleDict.md b/docs/v1/ontologies/models/LogicRuleDict.md index 489b47e3..74b56b1c 100644 --- a/docs/v1/ontologies/models/LogicRuleDict.md +++ b/docs/v1/ontologies/models/LogicRuleDict.md @@ -9,6 +9,7 @@ This discriminator class uses the `type` field to differentiate between classes. | Class | Value | ------------ | ------------- +DeleteInterfaceObjectRuleDict | deleteInterfaceObject ModifyInterfaceObjectRuleDict | modifyInterfaceObject ModifyObjectRuleDict | modifyObject DeleteObjectRuleDict | deleteObject diff --git a/docs/v1/ontologies/models/ModifyInterfaceObjectRule.md b/docs/v1/ontologies/models/ModifyInterfaceObjectRule.md index 44181958..53e9ee84 100644 --- a/docs/v1/ontologies/models/ModifyInterfaceObjectRule.md +++ b/docs/v1/ontologies/models/ModifyInterfaceObjectRule.md @@ -5,6 +5,7 @@ ModifyInterfaceObjectRule ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | +**interface_type_api_name** | InterfaceTypeApiName | Yes | | **type** | Literal["modifyInterfaceObject"] | Yes | None | diff --git a/docs/v1/ontologies/models/ModifyInterfaceObjectRuleDict.md b/docs/v1/ontologies/models/ModifyInterfaceObjectRuleDict.md index 280bcf51..07879db6 100644 --- a/docs/v1/ontologies/models/ModifyInterfaceObjectRuleDict.md +++ b/docs/v1/ontologies/models/ModifyInterfaceObjectRuleDict.md @@ -5,6 +5,7 @@ ModifyInterfaceObjectRule ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | +**interfaceTypeApiName** | InterfaceTypeApiName | Yes | | **type** | Literal["modifyInterfaceObject"] | Yes | None | diff --git a/docs/v1/ontologies/models/PropertyValue.md b/docs/v1/ontologies/models/PropertyValue.md index 1a7faf42..2cf59c94 100644 --- a/docs/v1/ontologies/models/PropertyValue.md +++ b/docs/v1/ontologies/models/PropertyValue.md @@ -2,23 +2,25 @@ Represents the value of a property in the following format. -| Type | JSON encoding | Example | -|----------- |-------------------------------------------------------|----------------------------------------------------------------------------------------------------| -| Array | array | `["alpha", "bravo", "charlie"]` | -| Attachment | JSON encoded `AttachmentProperty` object | `{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}` | -| Boolean | boolean | `true` | -| Byte | number | `31` | -| Date | ISO 8601 extended local date string | `"2021-05-01"` | -| Decimal | string | `"2.718281828"` | -| Double | number | `3.14159265` | -| Float | number | `3.14159265` | -| GeoPoint | geojson | `{"type":"Point","coordinates":[102.0,0.5]}` | -| GeoShape | geojson | `{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}` | -| Integer | number | `238940` | -| Long | string | `"58319870951433"` | -| Short | number | `8739` | -| String | string | `"Call me Ishmael"` | -| Timestamp | ISO 8601 extended offset date-time string in UTC zone | `"2021-01-04T05:00:00Z"` | +| Type | JSON encoding | Example | +|---------------- |-------------------------------------------------------------|----------------------------------------------------------------------------------------------------| +| Array | array | `["alpha", "bravo", "charlie"]` | +| Attachment | JSON encoded `AttachmentProperty` object | `{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}` | +| Boolean | boolean | `true` | +| Byte | number | `31` | +| Date | ISO 8601 extended local date string | `"2021-05-01"` | +| Decimal | string | `"2.718281828"` | +| Double | number | `3.14159265` | +| Float | number | `3.14159265` | +| GeoPoint | geojson | `{"type":"Point","coordinates":[102.0,0.5]}` | +| GeoShape | geojson | `{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}` | +| Integer | number | `238940` | +| Long | string | `"58319870951433"` | +| MediaReference | JSON encoded `MediaReference` object | `{"mimeType":"application/pdf","reference":{"type":"mediaSetViewItem","mediaSetViewItem":{"mediaSetRid":"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642","mediaSetViewRid":"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b","mediaItemRid":"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225"}}}` | +| Short | number | `8739` | +| String | string | `"Call me Ishmael"` | +| Timestamp | ISO 8601 extended offset date-time string in UTC zone | `"2021-01-04T05:00:00Z"` | +| Timeseries | JSON encoded `TimeseriesProperty` object or seriesId string | `{"seriesId": "wellPressureSeriesId", "syncRid": ri.time-series-catalog.main.sync.04f5ac1f-91bf-44f9-a51f-4f34e06e42df"}` or `{"templateRid": "ri.codex-emu.main.template.367cac64-e53b-4653-b111-f61856a63df9", "templateVersion": "0.0.0"}` or `"wellPressureSeriesId"`| | Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings. diff --git a/docs/v2/Admin/Group.md b/docs/v2/Admin/Group.md index 57d7aabd..dd631285 100644 --- a/docs/v2/Admin/Group.md +++ b/docs/v2/Admin/Group.md @@ -37,7 +37,17 @@ foundry_client = FoundryClient( ) # Dict[AttributeName, AttributeValues] | A map of the Group's attributes. Attributes prefixed with "multipass:" are reserved for internal use by Foundry and are subject to change. -attributes = None +attributes = { + "multipass:givenName": ["John"], + "multipass:familyName": ["Smith"], + "multipass:email:primary": ["jsmith@example.com"], + "multipass:realm": ["eab0a251-ca1a-4a84-a482-200edfb8026f"], + "multipass:organization-rid": [ + "ri.multipass..organization.c30ee6ad-b5e4-4afe-a74f-fe4a289f2faa" + ], + "department": ["Finance"], + "jobTitle": ["Accountant"], +} # GroupName | The name of the Group. name = "Data Source Admins" # List[OrganizationRid] | The RIDs of the Organizations whose members can see this group. At least one Organization RID must be listed. diff --git a/docs/v2/Connectivity/Connection.md b/docs/v2/Connectivity/Connection.md index 0e5793bb..b703e577 100644 --- a/docs/v2/Connectivity/Connection.md +++ b/docs/v2/Connectivity/Connection.md @@ -2,6 +2,7 @@ Method | HTTP request | ------------- | ------------- | +[**update_secrets**](#update_secrets) | **POST** /v2/connectivity/connections/{connectionRid}/updateSecrets | Get the Connection with the specified rid. @@ -57,9 +58,19 @@ See [README](../../../README.md#authorization) [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) +# **update_secrets** Updates the secrets on the connection to the specified secret values. Secrets that are currently configured on the connection but are omitted in the request will remain unchanged. +Secrets are transmitted over the network encrypted using TLS. Once the secrets reach Foundry's servers, +they will be temporarily decrypted and remain in plaintext in memory to be processed as needed. +They will stay in plaintext in memory until the garbage collection process cleans up the memory. +The secrets are always stored encrypted on our servers. + +By using this endpoint, you acknowledge and accept any potential risks associated with the temporary +in-memory handling of secrets. If you do not want your secrets to be temporarily decrypted, you should +use the Foundry UI instead. + ### Parameters @@ -86,7 +97,7 @@ foundry_client = FoundryClient( # ConnectionRid | connectionRid connection_rid = None # Dict[SecretName, PlaintextValue] | The secrets to be updated. The specified secret names must already be configured on the connection. -secrets = None +secrets = {"Password": "MySecretPassword"} # Optional[PreviewMode] | preview preview = None diff --git a/docs/v2/Connectivity/FileImport.md b/docs/v2/Connectivity/FileImport.md index 51e525c6..81822091 100644 --- a/docs/v2/Connectivity/FileImport.md +++ b/docs/v2/Connectivity/FileImport.md @@ -2,7 +2,14 @@ Method | HTTP request | ------------- | ------------- | - +[**create**](#create) | **POST** /v2/connectivity/connections/{connectionRid}/fileImports | +[**delete**](#delete) | **DELETE** /v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid} | +[**execute**](#execute) | **POST** /v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid}/execute | +[**get**](#get) | **GET** /v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid} | +[**list**](#list) | **GET** /v2/connectivity/connections/{connectionRid}/fileImports | +[**page**](#page) | **GET** /v2/connectivity/connections/{connectionRid}/fileImports | + +# **create** Creates a new FileImport. ### Parameters @@ -37,7 +44,7 @@ connection_rid = None # DatasetRid | The RID of the output dataset. dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" # FileImportDisplayName | -display_name = None +display_name = "My file import" # List[FileImportFilterDict] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) file_import_filters = None # FileImportMode | @@ -81,6 +88,7 @@ See [README](../../../README.md#authorization) [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) +# **delete** Delete the FileImport with the specified RID. Deleting the file import does not delete the destination dataset but the dataset will no longer be updated by this import. @@ -142,6 +150,7 @@ See [README](../../../README.md#authorization) [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) +# **execute** Executes the FileImport, which runs asynchronously as a [Foundry Build](/docs/foundry/data-integration/builds/). The returned BuildRid can be used to check the status via the Orchestration API. @@ -202,6 +211,7 @@ See [README](../../../README.md#authorization) [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) +# **get** Get the FileImport with the specified rid. ### Parameters @@ -260,6 +270,7 @@ See [README](../../../README.md#authorization) [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) +# **list** Lists all file imports defined for this connection. Only file imports that the user has permissions to view will be returned. @@ -319,6 +330,7 @@ See [README](../../../README.md#authorization) [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) +# **page** Lists all file imports defined for this connection. Only file imports that the user has permissions to view will be returned. @@ -383,3 +395,85 @@ See [README](../../../README.md#authorization) [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) +Replace the FileImport with the specified rid. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**connection_rid** | ConnectionRid | connectionRid | | +**file_import_rid** | FileImportRid | fileImportRid | | +**dataset_rid** | DatasetRid | The RID of the output dataset. | | +**display_name** | FileImportDisplayName | | | +**file_import_filters** | List[FileImportFilterDict] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) | | +**import_mode** | FileImportMode | | | +**branch_name** | Optional[BranchName] | The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | +**subfolder** | Optional[pydantic.StrictStr] | A subfolder in the external system that will be imported. If not specified, defaults to the root folder of the external system. | [optional] | + +### Return type +**FileImport** + +### Example + +```python +from foundry.v2 import FoundryClient +import foundry +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# ConnectionRid | connectionRid +connection_rid = None +# FileImportRid | fileImportRid +file_import_rid = None +# DatasetRid | The RID of the output dataset. +dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" +# FileImportDisplayName | +display_name = "My file import" +# List[FileImportFilterDict] | Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) +file_import_filters = None +# FileImportMode | +import_mode = "SNAPSHOT" +# Optional[BranchName] | The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. +branch_name = "master" +# Optional[PreviewMode] | preview +preview = None +# Optional[pydantic.StrictStr] | A subfolder in the external system that will be imported. If not specified, defaults to the root folder of the external system. +subfolder = "subfolder1/subfolder2" + + +try: + api_response = foundry_client.connectivity.Connection.FileImport.replace( + connection_rid, + file_import_rid, + dataset_rid=dataset_rid, + display_name=display_name, + file_import_filters=file_import_filters, + import_mode=import_mode, + branch_name=branch_name, + preview=preview, + subfolder=subfolder, + ) + print("The replace response:\n") + pprint(api_response) +except foundry.PalantirRPCException as e: + print("HTTP error when calling FileImport.replace: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | FileImport | The replaced FileImport | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/Connectivity/TableImport.md b/docs/v2/Connectivity/TableImport.md new file mode 100644 index 00000000..1aa00bd7 --- /dev/null +++ b/docs/v2/Connectivity/TableImport.md @@ -0,0 +1,258 @@ +# TableImport + +Method | HTTP request | +------------- | ------------- | + +Creates a new TableImport. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**connection_rid** | ConnectionRid | connectionRid | | +**config** | CreateTableImportRequestTableImportConfigDict | | | +**dataset_rid** | DatasetRid | The RID of the output dataset. | | +**display_name** | TableImportDisplayName | | | +**import_mode** | TableImportMode | | | +**branch_name** | Optional[BranchName] | The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. | [optional] | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**TableImport** + +### Example + +```python +from foundry.v2 import FoundryClient +import foundry +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# ConnectionRid | connectionRid +connection_rid = None +# CreateTableImportRequestTableImportConfigDict | +config = None +# DatasetRid | The RID of the output dataset. +dataset_rid = "ri.foundry.main.dataset.c26f11c8-cdb3-4f44-9f5d-9816ea1c82da" +# TableImportDisplayName | +display_name = None +# TableImportMode | +import_mode = "SNAPSHOT" +# Optional[BranchName] | The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. +branch_name = "master" +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.connectivity.Connection.TableImport.create( + connection_rid, + config=config, + dataset_rid=dataset_rid, + display_name=display_name, + import_mode=import_mode, + branch_name=branch_name, + preview=preview, + ) + print("The create response:\n") + pprint(api_response) +except foundry.PalantirRPCException as e: + print("HTTP error when calling TableImport.create: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | TableImport | The created TableImport | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +Delete the TableImport with the specified RID. +Deleting the table import does not delete the destination dataset but the dataset will no longer +be updated by this import. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**connection_rid** | ConnectionRid | connectionRid | | +**table_import_rid** | TableImportRid | tableImportRid | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**None** + +### Example + +```python +from foundry.v2 import FoundryClient +import foundry +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# ConnectionRid | connectionRid +connection_rid = None +# TableImportRid | tableImportRid +table_import_rid = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.connectivity.Connection.TableImport.delete( + connection_rid, + table_import_rid, + preview=preview, + ) + print("The delete response:\n") + pprint(api_response) +except foundry.PalantirRPCException as e: + print("HTTP error when calling TableImport.delete: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**204** | None | | None | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +Executes the TableImport, which runs asynchronously as a [Foundry Build](/docs/foundry/data-integration/builds/). +The returned BuildRid can be used to check the status via the Orchestration API. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**connection_rid** | ConnectionRid | connectionRid | | +**table_import_rid** | TableImportRid | tableImportRid | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**BuildRid** + +### Example + +```python +from foundry.v2 import FoundryClient +import foundry +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# ConnectionRid | connectionRid +connection_rid = None +# TableImportRid | tableImportRid +table_import_rid = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.connectivity.Connection.TableImport.execute( + connection_rid, + table_import_rid, + preview=preview, + ) + print("The execute response:\n") + pprint(api_response) +except foundry.PalantirRPCException as e: + print("HTTP error when calling TableImport.execute: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | BuildRid | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + +Get the TableImport with the specified rid. + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**connection_rid** | ConnectionRid | connectionRid | | +**table_import_rid** | TableImportRid | tableImportRid | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**TableImport** + +### Example + +```python +from foundry.v2 import FoundryClient +import foundry +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# ConnectionRid | connectionRid +connection_rid = None +# TableImportRid | tableImportRid +table_import_rid = None +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.connectivity.Connection.TableImport.get( + connection_rid, + table_import_rid, + preview=preview, + ) + print("The get response:\n") + pprint(api_response) +except foundry.PalantirRPCException as e: + print("HTTP error when calling TableImport.get: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**200** | TableImport | | application/json | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + diff --git a/docs/v2/Datasets/Dataset.md b/docs/v2/Datasets/Dataset.md index b57891a5..11e1ab3d 100644 --- a/docs/v2/Datasets/Dataset.md +++ b/docs/v2/Datasets/Dataset.md @@ -116,7 +116,7 @@ See [README](../../../README.md#authorization) # **read_table** Gets the content of a dataset as a table in the specified format. -This endpoint currently does not support views (Virtual datasets composed of other datasets). +This endpoint currently does not support views (virtual datasets composed of other datasets). ### Parameters @@ -152,7 +152,7 @@ format = None # Optional[BranchName] | branchName branch_name = None # Optional[List[pydantic.StrictStr]] | columns -columns = None +columns = ["id", "firstName", "lastName"] # Optional[TransactionRid] | endTransactionRid end_transaction_rid = None # Optional[pydantic.StrictInt] | rowLimit diff --git a/docs/v2/Orchestration/Build.md b/docs/v2/Orchestration/Build.md index 6c38afdd..1573c1bf 100644 --- a/docs/v2/Orchestration/Build.md +++ b/docs/v2/Orchestration/Build.md @@ -2,9 +2,66 @@ Method | HTTP request | ------------- | ------------- | +[**cancel**](#cancel) | **POST** /v2/orchestration/builds/{buildRid}/cancel | [**create**](#create) | **POST** /v2/orchestration/builds/create | [**get**](#get) | **GET** /v2/orchestration/builds/{buildRid} | +# **cancel** +Request a cancellation for all unfinished jobs in a build. The build's status will not update immediately. This endpoint is asynchronous and a success response indicates that the cancellation request has been acknowledged and the build is expected to be canceled soon. If the build has already finished or finishes shortly after the request and before the cancellation, the build will not change. + + +### Parameters + +Name | Type | Description | Notes | +------------- | ------------- | ------------- | ------------- | +**build_rid** | BuildRid | buildRid | | +**preview** | Optional[PreviewMode] | preview | [optional] | + +### Return type +**None** + +### Example + +```python +from foundry.v2 import FoundryClient +import foundry +from pprint import pprint + +foundry_client = FoundryClient( + auth=foundry.UserTokenAuth(...), hostname="example.palantirfoundry.com" +) + +# BuildRid | buildRid +build_rid = "ri.foundry.main.build.a4386b7e-d546-49be-8a36-eefc355f5c58" +# Optional[PreviewMode] | preview +preview = None + + +try: + api_response = foundry_client.orchestration.Build.cancel( + build_rid, + preview=preview, + ) + print("The cancel response:\n") + pprint(api_response) +except foundry.PalantirRPCException as e: + print("HTTP error when calling Build.cancel: %s\n" % e) + +``` + + + +### Authorization + +See [README](../../../README.md#authorization) + +### HTTP response details +| Status Code | Type | Description | Content Type | +|-------------|-------------|-------------|------------------| +**204** | None | | None | + +[[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) + # **create** @@ -17,7 +74,7 @@ Name | Type | Description | Notes | **abort_on_failure** | Optional[AbortOnFailure] | | [optional] | **branch_name** | Optional[BranchName] | The target branch the build should run on. | [optional] | **force_build** | Optional[ForceBuild] | | [optional] | -**notifications_enabled** | Optional[NotificationsEnabled] | | [optional] | +**notifications_enabled** | Optional[NotificationsEnabled] | The notification will be sent to the user that has most recently edited the schedule. No notification will be sent if the schedule has `scopeMode` set to `ProjectScope`. | [optional] | **preview** | Optional[PreviewMode] | preview | [optional] | **retry_backoff_duration** | Optional[RetryBackoffDurationDict] | | [optional] | **retry_count** | Optional[RetryCount] | The number of retry attempts for failed jobs. | [optional] | @@ -41,19 +98,19 @@ fallback_branches = ["master"] # BuildTargetDict | The targets of the schedule. target = None # Optional[AbortOnFailure] | -abort_on_failure = None +abort_on_failure = False # Optional[BranchName] | The target branch the build should run on. branch_name = "master" # Optional[ForceBuild] | force_build = None -# Optional[NotificationsEnabled] | +# Optional[NotificationsEnabled] | The notification will be sent to the user that has most recently edited the schedule. No notification will be sent if the schedule has `scopeMode` set to `ProjectScope`. notifications_enabled = None # Optional[PreviewMode] | preview preview = None # Optional[RetryBackoffDurationDict] | retry_backoff_duration = {"unit": "SECONDS", "value": 30} # Optional[RetryCount] | The number of retry attempts for failed jobs. -retry_count = None +retry_count = 1 try: diff --git a/docs/v2/Orchestration/Schedule.md b/docs/v2/Orchestration/Schedule.md index 639b7bb0..f7bfa132 100644 --- a/docs/v2/Orchestration/Schedule.md +++ b/docs/v2/Orchestration/Schedule.md @@ -43,6 +43,7 @@ action = { "abortOnFailure": False, "forceBuild": False, "retryBackoffDuration": {"unit": "SECONDS", "value": 30}, + "retryCount": 1, "fallbackBranches": [], "branchName": "master", "notificationsEnabled": False, @@ -296,6 +297,7 @@ action = { "abortOnFailure": False, "forceBuild": False, "retryBackoffDuration": {"unit": "SECONDS", "value": 30}, + "retryCount": 1, "fallbackBranches": [], "branchName": "master", "notificationsEnabled": False, diff --git a/docs/v2/Streams/Dataset.md b/docs/v2/Streams/Dataset.md index 95601484..c13dfce2 100644 --- a/docs/v2/Streams/Dataset.md +++ b/docs/v2/Streams/Dataset.md @@ -2,7 +2,9 @@ Method | HTTP request | ------------- | ------------- | +[**create**](#create) | **POST** /v2/streams/datasets/create | +# **create** Creates a streaming dataset with a stream on the specified branch, or if no branch is specified, on the default branch ('master' for most enrollments). For more information on streaming datasets, refer to the [streams](/docs/foundry/data-integration/streams/) user documentation. @@ -44,9 +46,9 @@ schema = None # Optional[BranchName] | The branch to create the initial stream on. If not specified, the default branch will be used ('master' for most enrollments). branch_name = "master" # Optional[Compressed] | Whether or not compression is enabled for the stream. Defaults to false. -compressed = None +compressed = False # Optional[PartitionsCount] | The number of partitions for the Foundry stream. Generally, each partition can handle about 5 mb/s of data, so for higher volume streams, more partitions are recommended. If not specified, 1 partition is used. This value cannot be changed later. -partitions_count = None +partitions_count = 1 # Optional[PreviewMode] | preview preview = None # Optional[StreamType] | A conceptual representation of the expected shape of the data for a stream. HIGH_THROUGHPUT and LOW_LATENCY are not compatible with each other. Defaults to LOW_LATENCY. diff --git a/docs/v2/Streams/Stream.md b/docs/v2/Streams/Stream.md index 8b247129..78e263e7 100644 --- a/docs/v2/Streams/Stream.md +++ b/docs/v2/Streams/Stream.md @@ -2,7 +2,14 @@ Method | HTTP request | ------------- | ------------- | - +[**create**](#create) | **POST** /v2/streams/datasets/{datasetRid}/streams | +[**get**](#get) | **GET** /v2/streams/datasets/{datasetRid}/streams/{streamBranchName} | +[**publish_binary_record**](#publish_binary_record) | **POST** /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishBinaryRecord | +[**publish_record**](#publish_record) | **POST** /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecord | +[**publish_records**](#publish_records) | **POST** /v2/highScale/streams/datasets/{datasetRid}/streams/{streamBranchName}/publishRecords | +[**reset**](#reset) | **POST** /v2/streams/datasets/{datasetRid}/streams/{streamBranchName}/reset | + +# **create** Creates a new branch on the backing streaming dataset, and creates a new stream on that branch. @@ -39,7 +46,7 @@ branch_name = "master" # CreateStreamRequestStreamSchemaDict | The Foundry schema for this stream. schema = None # Optional[Compressed] | Whether or not compression is enabled for the stream. Defaults to false. -compressed = None +compressed = False # Optional[PartitionsCount] | The number of partitions for the Foundry stream. Defaults to 1. Generally, each partition can handle about 5 mb/s of data, so for higher volume streams, more partitions are recommended. partitions_count = 1 # Optional[PreviewMode] | preview @@ -78,6 +85,7 @@ See [README](../../../README.md#authorization) [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) +# **get** Get a stream by its branch name. If the branch does not exist, there is no stream on that branch, or the user does not have permission to access the stream, a 404 error will be returned. @@ -138,6 +146,7 @@ See [README](../../../README.md#authorization) [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) +# **publish_binary_record** Publish a single binary record to the stream. The stream's schema must be a single binary field. @@ -205,6 +214,7 @@ See [README](../../../README.md#authorization) [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) +# **publish_record** Publish a single record to the stream. The record will be validated against the stream's schema, and rejected if it is invalid. @@ -238,11 +248,11 @@ dataset_rid = None # BranchName | streamBranchName stream_branch_name = None # Record | The record to publish to the stream -record = None +record = {"timestamp": 1731426022784, "value": "Hello, World!"} # Optional[PreviewMode] | preview preview = None # Optional[ViewRid] | If provided, this endpoint will only write to the stream corresponding to the specified view rid. If not provided, this endpoint will write the latest stream on the branch. Providing this value is an advanced configuration, to be used when additional control over the underlying streaming data structures is needed. -view_rid = None +view_rid = "ri.foundry-streaming.main.view.ecd4f0f6-8526-4468-9eda-14939449ad79" try: @@ -273,6 +283,7 @@ See [README](../../../README.md#authorization) [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) +# **publish_records** Publish a batch of records to the stream. The records will be validated against the stream's schema, and the batch will be rejected if one or more of the records are invalid. @@ -306,11 +317,11 @@ dataset_rid = None # BranchName | streamBranchName stream_branch_name = None # List[Record] | The records to publish to the stream -records = None +records = [{"timestamp": 1731426022784, "value": "Hello, World!"}] # Optional[PreviewMode] | preview preview = None # Optional[ViewRid] | If provided, this endpoint will only write to the stream corresponding to the specified view rid. If not provided, this endpoint will write to the latest stream on the branch. Providing this value is an advanced configuration, to be used when additional control over the underlying streaming data structures is needed. -view_rid = None +view_rid = "ri.foundry-streaming.main.view.ecd4f0f6-8526-4468-9eda-14939449ad79" try: @@ -341,6 +352,7 @@ See [README](../../../README.md#authorization) [[Back to top]](#) [[Back to API list]](../../../README.md#apis-v2-link) [[Back to Model list]](../../../README.md#models-v2-link) [[Back to README]](../../../README.md) +# **reset** Reset the stream on the given dataset branch, clearing the existing records and allowing new configurations to be applied. @@ -381,9 +393,9 @@ dataset_rid = None # BranchName | streamBranchName stream_branch_name = None # Optional[Compressed] | Whether or not compression is enabled for the stream. If omitted, the compression setting of the existing stream on the branch will be used. -compressed = None +compressed = False # Optional[PartitionsCount] | The number of partitions for the Foundry stream. Generally, each partition can handle about 5 mb/s of data, so for higher volume streams, more partitions are recommended. If omitted, the partitions count of the existing stream on the branch will be used. -partitions_count = None +partitions_count = 1 # Optional[PreviewMode] | preview preview = None # Optional[StreamSchemaDict] | The Foundry schema to apply to the new stream. If omitted, the schema of the existing stream on the branch will be used. diff --git a/docs/v2/connectivity/models/CloudIdentity.md b/docs/v2/connectivity/models/CloudIdentity.md new file mode 100644 index 00000000..3d605a69 --- /dev/null +++ b/docs/v2/connectivity/models/CloudIdentity.md @@ -0,0 +1,14 @@ +# CloudIdentity + +[Cloud identities](/docs/foundry/administration/configure-cloud-identities/) allow you to authenticate to +cloud provider resources without the use of static credentials. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**cloud_identity_rid** | CloudIdentityRid | Yes | | +**type** | Literal["cloudIdentity"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/CloudIdentityDict.md b/docs/v2/connectivity/models/CloudIdentityDict.md new file mode 100644 index 00000000..e7292537 --- /dev/null +++ b/docs/v2/connectivity/models/CloudIdentityDict.md @@ -0,0 +1,14 @@ +# CloudIdentityDict + +[Cloud identities](/docs/foundry/administration/configure-cloud-identities/) allow you to authenticate to +cloud provider resources without the use of static credentials. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**cloudIdentityRid** | CloudIdentityRid | Yes | | +**type** | Literal["cloudIdentity"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/CloudIdentityRid.md b/docs/v2/connectivity/models/CloudIdentityRid.md new file mode 100644 index 00000000..f7977285 --- /dev/null +++ b/docs/v2/connectivity/models/CloudIdentityRid.md @@ -0,0 +1,12 @@ +# CloudIdentityRid + +The Resource Identifier (RID) of a Cloud Identity. + + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/Connection.md b/docs/v2/connectivity/models/Connection.md index 55d01ac6..11702e84 100644 --- a/docs/v2/connectivity/models/Connection.md +++ b/docs/v2/connectivity/models/Connection.md @@ -6,6 +6,7 @@ Connection | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | **rid** | ConnectionRid | Yes | | +**parent_folder_rid** | FolderRid | Yes | | **display_name** | ConnectionDisplayName | Yes | | **runtime_platform** | RuntimePlatform | Yes | | **configuration** | ConnectionConfiguration | Yes | | diff --git a/docs/v2/connectivity/models/ConnectionDict.md b/docs/v2/connectivity/models/ConnectionDict.md index e449ec52..bf56dbeb 100644 --- a/docs/v2/connectivity/models/ConnectionDict.md +++ b/docs/v2/connectivity/models/ConnectionDict.md @@ -6,6 +6,7 @@ Connection | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | **rid** | ConnectionRid | Yes | | +**parentFolderRid** | FolderRid | Yes | | **displayName** | ConnectionDisplayName | Yes | | **runtimePlatform** | RuntimePlatformDict | Yes | | **configuration** | ConnectionConfigurationDict | Yes | | diff --git a/docs/v2/connectivity/models/CreateTableImportRequestJdbcImportConfigDict.md b/docs/v2/connectivity/models/CreateTableImportRequestJdbcImportConfigDict.md new file mode 100644 index 00000000..58d56a8f --- /dev/null +++ b/docs/v2/connectivity/models/CreateTableImportRequestJdbcImportConfigDict.md @@ -0,0 +1,12 @@ +# CreateTableImportRequestJdbcImportConfigDict + +CreateTableImportRequestJdbcImportConfig + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**query** | pydantic.StrictStr | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | +**type** | Literal["jdbcImportConfig"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/CreateTableImportRequestMicrosoftAccessImportConfigDict.md b/docs/v2/connectivity/models/CreateTableImportRequestMicrosoftAccessImportConfigDict.md new file mode 100644 index 00000000..9d9bc4ad --- /dev/null +++ b/docs/v2/connectivity/models/CreateTableImportRequestMicrosoftAccessImportConfigDict.md @@ -0,0 +1,12 @@ +# CreateTableImportRequestMicrosoftAccessImportConfigDict + +CreateTableImportRequestMicrosoftAccessImportConfig + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**query** | pydantic.StrictStr | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | +**type** | Literal["microsoftAccessImportConfig"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/CreateTableImportRequestMicrosoftSqlServerImportConfigDict.md b/docs/v2/connectivity/models/CreateTableImportRequestMicrosoftSqlServerImportConfigDict.md new file mode 100644 index 00000000..e6bf9947 --- /dev/null +++ b/docs/v2/connectivity/models/CreateTableImportRequestMicrosoftSqlServerImportConfigDict.md @@ -0,0 +1,12 @@ +# CreateTableImportRequestMicrosoftSqlServerImportConfigDict + +CreateTableImportRequestMicrosoftSqlServerImportConfig + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**query** | pydantic.StrictStr | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | +**type** | Literal["microsoftSqlServerImportConfig"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/CreateTableImportRequestOracleImportConfigDict.md b/docs/v2/connectivity/models/CreateTableImportRequestOracleImportConfigDict.md new file mode 100644 index 00000000..97c1d2ee --- /dev/null +++ b/docs/v2/connectivity/models/CreateTableImportRequestOracleImportConfigDict.md @@ -0,0 +1,12 @@ +# CreateTableImportRequestOracleImportConfigDict + +CreateTableImportRequestOracleImportConfig + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**query** | pydantic.StrictStr | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | +**type** | Literal["oracleImportConfig"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/CreateTableImportRequestPostgreSqlImportConfigDict.md b/docs/v2/connectivity/models/CreateTableImportRequestPostgreSqlImportConfigDict.md new file mode 100644 index 00000000..0a1067a4 --- /dev/null +++ b/docs/v2/connectivity/models/CreateTableImportRequestPostgreSqlImportConfigDict.md @@ -0,0 +1,12 @@ +# CreateTableImportRequestPostgreSqlImportConfigDict + +CreateTableImportRequestPostgreSqlImportConfig + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**query** | pydantic.StrictStr | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | +**type** | Literal["postgreSqlImportConfig"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/CreateTableImportRequestTableImportConfigDict.md b/docs/v2/connectivity/models/CreateTableImportRequestTableImportConfigDict.md new file mode 100644 index 00000000..df403e46 --- /dev/null +++ b/docs/v2/connectivity/models/CreateTableImportRequestTableImportConfigDict.md @@ -0,0 +1,20 @@ +# CreateTableImportRequestTableImportConfigDict + +The import configuration for a specific [connector type](docs/foundry/data-integration/source-type-overview). + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +CreateTableImportRequestJdbcImportConfigDict | jdbcImportConfig +CreateTableImportRequestMicrosoftSqlServerImportConfigDict | microsoftSqlServerImportConfig +CreateTableImportRequestPostgreSqlImportConfigDict | postgreSqlImportConfig +CreateTableImportRequestMicrosoftAccessImportConfigDict | microsoftAccessImportConfig +CreateTableImportRequestOracleImportConfigDict | oracleImportConfig + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/JdbcImportConfig.md b/docs/v2/connectivity/models/JdbcImportConfig.md new file mode 100644 index 00000000..55e00b11 --- /dev/null +++ b/docs/v2/connectivity/models/JdbcImportConfig.md @@ -0,0 +1,13 @@ +# JdbcImportConfig + +The import configuration for a [custom JDBC connection](docs/foundry/available-connectors/custom-jdbc-sources). + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**query** | pydantic.StrictStr | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | +**type** | Literal["jdbcImportConfig"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/JdbcImportConfigDict.md b/docs/v2/connectivity/models/JdbcImportConfigDict.md new file mode 100644 index 00000000..1095a331 --- /dev/null +++ b/docs/v2/connectivity/models/JdbcImportConfigDict.md @@ -0,0 +1,13 @@ +# JdbcImportConfigDict + +The import configuration for a [custom JDBC connection](docs/foundry/available-connectors/custom-jdbc-sources). + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**query** | pydantic.StrictStr | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | +**type** | Literal["jdbcImportConfig"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/MicrosoftAccessImportConfig.md b/docs/v2/connectivity/models/MicrosoftAccessImportConfig.md new file mode 100644 index 00000000..330d807d --- /dev/null +++ b/docs/v2/connectivity/models/MicrosoftAccessImportConfig.md @@ -0,0 +1,13 @@ +# MicrosoftAccessImportConfig + +The import configuration for a [Microsoft Access connection](docs/foundry/available-connectors/microsoft-access). + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**query** | pydantic.StrictStr | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | +**type** | Literal["microsoftAccessImportConfig"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/MicrosoftAccessImportConfigDict.md b/docs/v2/connectivity/models/MicrosoftAccessImportConfigDict.md new file mode 100644 index 00000000..3be9952b --- /dev/null +++ b/docs/v2/connectivity/models/MicrosoftAccessImportConfigDict.md @@ -0,0 +1,13 @@ +# MicrosoftAccessImportConfigDict + +The import configuration for a [Microsoft Access connection](docs/foundry/available-connectors/microsoft-access). + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**query** | pydantic.StrictStr | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | +**type** | Literal["microsoftAccessImportConfig"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/MicrosoftSqlServerImportConfig.md b/docs/v2/connectivity/models/MicrosoftSqlServerImportConfig.md new file mode 100644 index 00000000..b1a6e8a2 --- /dev/null +++ b/docs/v2/connectivity/models/MicrosoftSqlServerImportConfig.md @@ -0,0 +1,13 @@ +# MicrosoftSqlServerImportConfig + +The import configuration for a [Microsoft SQL Server connection](docs/foundry/available-connectors/microsoft-sql-server). + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**query** | pydantic.StrictStr | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | +**type** | Literal["microsoftSqlServerImportConfig"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/MicrosoftSqlServerImportConfigDict.md b/docs/v2/connectivity/models/MicrosoftSqlServerImportConfigDict.md new file mode 100644 index 00000000..a66b3300 --- /dev/null +++ b/docs/v2/connectivity/models/MicrosoftSqlServerImportConfigDict.md @@ -0,0 +1,13 @@ +# MicrosoftSqlServerImportConfigDict + +The import configuration for a [Microsoft SQL Server connection](docs/foundry/available-connectors/microsoft-sql-server). + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**query** | pydantic.StrictStr | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | +**type** | Literal["microsoftSqlServerImportConfig"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/Oidc.md b/docs/v2/connectivity/models/Oidc.md new file mode 100644 index 00000000..6c8d1083 --- /dev/null +++ b/docs/v2/connectivity/models/Oidc.md @@ -0,0 +1,16 @@ +# Oidc + +[OpenID Connect (OIDC)](/docs/foundry/data-connection/oidc/) is an open authentication protocol that allows +you to authenticate to external system resources without the use of static credentials. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**audience** | pydantic.StrictStr | Yes | The configured audience that identifies the external system. | +**issuer_url** | pydantic.StrictStr | Yes | The URL that identifies Foundry as an OIDC identity provider. | +**subject** | ConnectionRid | Yes | The RID of the Connection that is connecting to the external system. | +**type** | Literal["oidc"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/OidcDict.md b/docs/v2/connectivity/models/OidcDict.md new file mode 100644 index 00000000..309e5bce --- /dev/null +++ b/docs/v2/connectivity/models/OidcDict.md @@ -0,0 +1,16 @@ +# OidcDict + +[OpenID Connect (OIDC)](/docs/foundry/data-connection/oidc/) is an open authentication protocol that allows +you to authenticate to external system resources without the use of static credentials. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**audience** | pydantic.StrictStr | Yes | The configured audience that identifies the external system. | +**issuerUrl** | pydantic.StrictStr | Yes | The URL that identifies Foundry as an OIDC identity provider. | +**subject** | ConnectionRid | Yes | The RID of the Connection that is connecting to the external system. | +**type** | Literal["oidc"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/OracleImportConfig.md b/docs/v2/connectivity/models/OracleImportConfig.md new file mode 100644 index 00000000..e2a451a5 --- /dev/null +++ b/docs/v2/connectivity/models/OracleImportConfig.md @@ -0,0 +1,13 @@ +# OracleImportConfig + +The import configuration for an Oracle Database 21 connection. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**query** | pydantic.StrictStr | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | +**type** | Literal["oracleImportConfig"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/OracleImportConfigDict.md b/docs/v2/connectivity/models/OracleImportConfigDict.md new file mode 100644 index 00000000..b2496dce --- /dev/null +++ b/docs/v2/connectivity/models/OracleImportConfigDict.md @@ -0,0 +1,13 @@ +# OracleImportConfigDict + +The import configuration for an Oracle Database 21 connection. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**query** | pydantic.StrictStr | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | +**type** | Literal["oracleImportConfig"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/PostgreSqlImportConfig.md b/docs/v2/connectivity/models/PostgreSqlImportConfig.md new file mode 100644 index 00000000..bd2c939b --- /dev/null +++ b/docs/v2/connectivity/models/PostgreSqlImportConfig.md @@ -0,0 +1,13 @@ +# PostgreSqlImportConfig + +The import configuration for a [PostgreSQL connection](docs/foundry/available-connectors/postgresql). + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**query** | pydantic.StrictStr | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | +**type** | Literal["postgreSqlImportConfig"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/PostgreSqlImportConfigDict.md b/docs/v2/connectivity/models/PostgreSqlImportConfigDict.md new file mode 100644 index 00000000..45e7d069 --- /dev/null +++ b/docs/v2/connectivity/models/PostgreSqlImportConfigDict.md @@ -0,0 +1,13 @@ +# PostgreSqlImportConfigDict + +The import configuration for a [PostgreSQL connection](docs/foundry/available-connectors/postgresql). + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**query** | pydantic.StrictStr | Yes | A single SQL query can be executed per sync, which should output a data table and avoid operations like invoking stored procedures. The query results are saved to the output dataset in Foundry. | +**type** | Literal["postgreSqlImportConfig"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/S3AuthenticationMode.md b/docs/v2/connectivity/models/S3AuthenticationMode.md index 771e0ab6..358e3a3f 100644 --- a/docs/v2/connectivity/models/S3AuthenticationMode.md +++ b/docs/v2/connectivity/models/S3AuthenticationMode.md @@ -2,10 +2,16 @@ S3AuthenticationMode -## Type -```python -AwsAccessKey -``` +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +AwsAccessKey | awsAccessKey +CloudIdentity | cloudIdentity +Oidc | oidc [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/S3AuthenticationModeDict.md b/docs/v2/connectivity/models/S3AuthenticationModeDict.md index 57ef36be..0d617d0a 100644 --- a/docs/v2/connectivity/models/S3AuthenticationModeDict.md +++ b/docs/v2/connectivity/models/S3AuthenticationModeDict.md @@ -2,10 +2,16 @@ S3AuthenticationMode -## Type -```python -AwsAccessKeyDict -``` +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +AwsAccessKeyDict | awsAccessKey +CloudIdentityDict | cloudIdentity +OidcDict | oidc [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/TableImport.md b/docs/v2/connectivity/models/TableImport.md new file mode 100644 index 00000000..5f233cdc --- /dev/null +++ b/docs/v2/connectivity/models/TableImport.md @@ -0,0 +1,17 @@ +# TableImport + +TableImport + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | TableImportRid | Yes | | +**connection_rid** | ConnectionRid | Yes | The RID of the Connection (formerly known as a source) that the Table Import uses to import data. | +**dataset_rid** | DatasetRid | Yes | The RID of the output dataset. | +**branch_name** | Optional[BranchName] | No | The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. | +**display_name** | TableImportDisplayName | Yes | | +**import_mode** | TableImportMode | Yes | | +**config** | TableImportConfig | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/TableImportConfig.md b/docs/v2/connectivity/models/TableImportConfig.md new file mode 100644 index 00000000..955faa76 --- /dev/null +++ b/docs/v2/connectivity/models/TableImportConfig.md @@ -0,0 +1,20 @@ +# TableImportConfig + +The import configuration for a specific [connector type](docs/foundry/data-integration/source-type-overview). + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +JdbcImportConfig | jdbcImportConfig +MicrosoftSqlServerImportConfig | microsoftSqlServerImportConfig +PostgreSqlImportConfig | postgreSqlImportConfig +MicrosoftAccessImportConfig | microsoftAccessImportConfig +OracleImportConfig | oracleImportConfig + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/TableImportConfigDict.md b/docs/v2/connectivity/models/TableImportConfigDict.md new file mode 100644 index 00000000..0c9bf461 --- /dev/null +++ b/docs/v2/connectivity/models/TableImportConfigDict.md @@ -0,0 +1,20 @@ +# TableImportConfigDict + +The import configuration for a specific [connector type](docs/foundry/data-integration/source-type-overview). + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +JdbcImportConfigDict | jdbcImportConfig +MicrosoftSqlServerImportConfigDict | microsoftSqlServerImportConfig +PostgreSqlImportConfigDict | postgreSqlImportConfig +MicrosoftAccessImportConfigDict | microsoftAccessImportConfig +OracleImportConfigDict | oracleImportConfig + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/TableImportDict.md b/docs/v2/connectivity/models/TableImportDict.md new file mode 100644 index 00000000..cb2144be --- /dev/null +++ b/docs/v2/connectivity/models/TableImportDict.md @@ -0,0 +1,17 @@ +# TableImportDict + +TableImport + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**rid** | TableImportRid | Yes | | +**connectionRid** | ConnectionRid | Yes | The RID of the Connection (formerly known as a source) that the Table Import uses to import data. | +**datasetRid** | DatasetRid | Yes | The RID of the output dataset. | +**branchName** | NotRequired[BranchName] | No | The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. | +**displayName** | TableImportDisplayName | Yes | | +**importMode** | TableImportMode | Yes | | +**config** | TableImportConfigDict | Yes | | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/TableImportDisplayName.md b/docs/v2/connectivity/models/TableImportDisplayName.md new file mode 100644 index 00000000..36a5b8a1 --- /dev/null +++ b/docs/v2/connectivity/models/TableImportDisplayName.md @@ -0,0 +1,11 @@ +# TableImportDisplayName + +TableImportDisplayName + +## Type +```python +pydantic.StrictStr +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/TableImportMode.md b/docs/v2/connectivity/models/TableImportMode.md new file mode 100644 index 00000000..fa022c11 --- /dev/null +++ b/docs/v2/connectivity/models/TableImportMode.md @@ -0,0 +1,15 @@ +# TableImportMode + +Import mode governs how data is read from an external system, and written into a Foundry dataset. + +SNAPSHOT: Defines a new dataset state consisting only of data from a particular import execution. +APPEND: Purely additive and yields data from previous import executions in addition to newly added data. + + +| **Value** | +| --------- | +| `"SNAPSHOT"` | +| `"APPEND"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/connectivity/models/TableImportRid.md b/docs/v2/connectivity/models/TableImportRid.md new file mode 100644 index 00000000..9ec68673 --- /dev/null +++ b/docs/v2/connectivity/models/TableImportRid.md @@ -0,0 +1,12 @@ +# TableImportRid + +The Resource Identifier (RID) of a TableImport (formerly known as a batch sync). + + +## Type +```python +RID +``` + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/core/models/FilePath.md b/docs/v2/core/models/FilePath.md index 0b4bf022..3932f027 100644 --- a/docs/v2/core/models/FilePath.md +++ b/docs/v2/core/models/FilePath.md @@ -1,6 +1,6 @@ # FilePath -The path to a File within Foundry. Examples: `my-file.txt`, `path/to/my-file.jpg`, `dataframe.snappy.parquet`. +The path to a File within Foundry. ## Type diff --git a/docs/v2/core/models/TimeseriesType.md b/docs/v2/core/models/TimeseriesType.md index e662b020..95b89758 100644 --- a/docs/v2/core/models/TimeseriesType.md +++ b/docs/v2/core/models/TimeseriesType.md @@ -5,7 +5,7 @@ TimeseriesType ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**item_type** | TimeSeriesItemType | Yes | | +**item_type** | Optional[TimeSeriesItemType] | No | | **type** | Literal["timeseries"] | Yes | None | diff --git a/docs/v2/core/models/TimeseriesTypeDict.md b/docs/v2/core/models/TimeseriesTypeDict.md index c0bc0ab3..edd36266 100644 --- a/docs/v2/core/models/TimeseriesTypeDict.md +++ b/docs/v2/core/models/TimeseriesTypeDict.md @@ -5,7 +5,7 @@ TimeseriesType ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**itemType** | TimeSeriesItemTypeDict | Yes | | +**itemType** | NotRequired[TimeSeriesItemTypeDict] | No | | **type** | Literal["timeseries"] | Yes | None | diff --git a/docs/v2/ontologies/models/ActionParameterType.md b/docs/v2/ontologies/models/ActionParameterType.md index b15a50a1..ef492fe1 100644 --- a/docs/v2/ontologies/models/ActionParameterType.md +++ b/docs/v2/ontologies/models/ActionParameterType.md @@ -11,15 +11,17 @@ This discriminator class uses the `type` field to differentiate between classes. | Class | Value | ------------ | ------------- DateType | date +OntologyInterfaceObjectType | interfaceObject +StringType | string +DoubleType | double +IntegerType | integer +LongType | long +OntologyObjectTypeReferenceType | objectType BooleanType | boolean MarkingType | marking AttachmentType | attachment -StringType | string ActionParameterArrayType | array OntologyObjectSetType | objectSet -DoubleType | double -IntegerType | integer -LongType | long OntologyObjectType | object TimestampType | timestamp diff --git a/docs/v2/ontologies/models/ActionParameterTypeDict.md b/docs/v2/ontologies/models/ActionParameterTypeDict.md index c6ca5949..828188cf 100644 --- a/docs/v2/ontologies/models/ActionParameterTypeDict.md +++ b/docs/v2/ontologies/models/ActionParameterTypeDict.md @@ -11,15 +11,17 @@ This discriminator class uses the `type` field to differentiate between classes. | Class | Value | ------------ | ------------- DateTypeDict | date +OntologyInterfaceObjectTypeDict | interfaceObject +StringTypeDict | string +DoubleTypeDict | double +IntegerTypeDict | integer +LongTypeDict | long +OntologyObjectTypeReferenceTypeDict | objectType BooleanTypeDict | boolean MarkingTypeDict | marking AttachmentTypeDict | attachment -StringTypeDict | string ActionParameterArrayTypeDict | array OntologyObjectSetTypeDict | objectSet -DoubleTypeDict | double -IntegerTypeDict | integer -LongTypeDict | long OntologyObjectTypeDict | object TimestampTypeDict | timestamp diff --git a/docs/v2/ontologies/models/ActivePropertyTypeStatus.md b/docs/v2/ontologies/models/ActivePropertyTypeStatus.md new file mode 100644 index 00000000..c7c6c20d --- /dev/null +++ b/docs/v2/ontologies/models/ActivePropertyTypeStatus.md @@ -0,0 +1,13 @@ +# ActivePropertyTypeStatus + +This status indicates that the PropertyType will not change on short notice and should thus be safe to use in +user facing workflows. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["active"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ActivePropertyTypeStatusDict.md b/docs/v2/ontologies/models/ActivePropertyTypeStatusDict.md new file mode 100644 index 00000000..b5d47c03 --- /dev/null +++ b/docs/v2/ontologies/models/ActivePropertyTypeStatusDict.md @@ -0,0 +1,13 @@ +# ActivePropertyTypeStatusDict + +This status indicates that the PropertyType will not change on short notice and should thus be safe to use in +user facing workflows. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["active"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/CreateInterfaceObjectRule.md b/docs/v2/ontologies/models/CreateInterfaceObjectRule.md index 1cbac523..711eb22d 100644 --- a/docs/v2/ontologies/models/CreateInterfaceObjectRule.md +++ b/docs/v2/ontologies/models/CreateInterfaceObjectRule.md @@ -5,6 +5,7 @@ CreateInterfaceObjectRule ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | +**interface_type_api_name** | InterfaceTypeApiName | Yes | | **type** | Literal["createInterfaceObject"] | Yes | None | diff --git a/docs/v2/ontologies/models/CreateInterfaceObjectRuleDict.md b/docs/v2/ontologies/models/CreateInterfaceObjectRuleDict.md index 5826dcc7..84d1c825 100644 --- a/docs/v2/ontologies/models/CreateInterfaceObjectRuleDict.md +++ b/docs/v2/ontologies/models/CreateInterfaceObjectRuleDict.md @@ -5,6 +5,7 @@ CreateInterfaceObjectRule ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | +**interfaceTypeApiName** | InterfaceTypeApiName | Yes | | **type** | Literal["createInterfaceObject"] | Yes | None | diff --git a/docs/v2/ontologies/models/DeleteInterfaceObjectRule.md b/docs/v2/ontologies/models/DeleteInterfaceObjectRule.md new file mode 100644 index 00000000..0da183a2 --- /dev/null +++ b/docs/v2/ontologies/models/DeleteInterfaceObjectRule.md @@ -0,0 +1,12 @@ +# DeleteInterfaceObjectRule + +DeleteInterfaceObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**interface_type_api_name** | InterfaceTypeApiName | Yes | | +**type** | Literal["deleteInterfaceObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/DeleteInterfaceObjectRuleDict.md b/docs/v2/ontologies/models/DeleteInterfaceObjectRuleDict.md new file mode 100644 index 00000000..3757592b --- /dev/null +++ b/docs/v2/ontologies/models/DeleteInterfaceObjectRuleDict.md @@ -0,0 +1,12 @@ +# DeleteInterfaceObjectRuleDict + +DeleteInterfaceObjectRule + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**interfaceTypeApiName** | InterfaceTypeApiName | Yes | | +**type** | Literal["deleteInterfaceObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/DeprecatedPropertyTypeStatus.md b/docs/v2/ontologies/models/DeprecatedPropertyTypeStatus.md new file mode 100644 index 00000000..30c3bef7 --- /dev/null +++ b/docs/v2/ontologies/models/DeprecatedPropertyTypeStatus.md @@ -0,0 +1,16 @@ +# DeprecatedPropertyTypeStatus + +This status indicates that the PropertyType is reaching the end of its life and will be removed as per the +deadline specified. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**message** | pydantic.StrictStr | Yes | | +**deadline** | datetime | Yes | | +**replaced_by** | Optional[PropertyTypeRid] | No | | +**type** | Literal["deprecated"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/DeprecatedPropertyTypeStatusDict.md b/docs/v2/ontologies/models/DeprecatedPropertyTypeStatusDict.md new file mode 100644 index 00000000..b5f1061b --- /dev/null +++ b/docs/v2/ontologies/models/DeprecatedPropertyTypeStatusDict.md @@ -0,0 +1,16 @@ +# DeprecatedPropertyTypeStatusDict + +This status indicates that the PropertyType is reaching the end of its life and will be removed as per the +deadline specified. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**message** | pydantic.StrictStr | Yes | | +**deadline** | datetime | Yes | | +**replacedBy** | NotRequired[PropertyTypeRid] | No | | +**type** | Literal["deprecated"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ExamplePropertyTypeStatus.md b/docs/v2/ontologies/models/ExamplePropertyTypeStatus.md new file mode 100644 index 00000000..5abd55e9 --- /dev/null +++ b/docs/v2/ontologies/models/ExamplePropertyTypeStatus.md @@ -0,0 +1,13 @@ +# ExamplePropertyTypeStatus + +This status indicates that the PropertyType is an example. It is backed by notional data that should not be +used for actual workflows, but can be used to test those workflows. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["example"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ExamplePropertyTypeStatusDict.md b/docs/v2/ontologies/models/ExamplePropertyTypeStatusDict.md new file mode 100644 index 00000000..1c2e41ca --- /dev/null +++ b/docs/v2/ontologies/models/ExamplePropertyTypeStatusDict.md @@ -0,0 +1,13 @@ +# ExamplePropertyTypeStatusDict + +This status indicates that the PropertyType is an example. It is backed by notional data that should not be +used for actual workflows, but can be used to test those workflows. + + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["example"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ExperimentalPropertyTypeStatus.md b/docs/v2/ontologies/models/ExperimentalPropertyTypeStatus.md new file mode 100644 index 00000000..ac241a19 --- /dev/null +++ b/docs/v2/ontologies/models/ExperimentalPropertyTypeStatus.md @@ -0,0 +1,11 @@ +# ExperimentalPropertyTypeStatus + +This status indicates that the PropertyType is in development. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["experimental"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/ExperimentalPropertyTypeStatusDict.md b/docs/v2/ontologies/models/ExperimentalPropertyTypeStatusDict.md new file mode 100644 index 00000000..b12012a3 --- /dev/null +++ b/docs/v2/ontologies/models/ExperimentalPropertyTypeStatusDict.md @@ -0,0 +1,11 @@ +# ExperimentalPropertyTypeStatusDict + +This status indicates that the PropertyType is in development. + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["experimental"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/LogicRule.md b/docs/v2/ontologies/models/LogicRule.md index 0e31b10e..cb9faa92 100644 --- a/docs/v2/ontologies/models/LogicRule.md +++ b/docs/v2/ontologies/models/LogicRule.md @@ -9,6 +9,7 @@ This discriminator class uses the `type` field to differentiate between classes. | Class | Value | ------------ | ------------- +DeleteInterfaceObjectRule | deleteInterfaceObject ModifyInterfaceObjectRule | modifyInterfaceObject ModifyObjectRule | modifyObject DeleteObjectRule | deleteObject diff --git a/docs/v2/ontologies/models/LogicRuleDict.md b/docs/v2/ontologies/models/LogicRuleDict.md index dcc52ea2..b7c6ad34 100644 --- a/docs/v2/ontologies/models/LogicRuleDict.md +++ b/docs/v2/ontologies/models/LogicRuleDict.md @@ -9,6 +9,7 @@ This discriminator class uses the `type` field to differentiate between classes. | Class | Value | ------------ | ------------- +DeleteInterfaceObjectRuleDict | deleteInterfaceObject ModifyInterfaceObjectRuleDict | modifyInterfaceObject ModifyObjectRuleDict | modifyObject DeleteObjectRuleDict | deleteObject diff --git a/docs/v2/ontologies/models/ModifyInterfaceObjectRule.md b/docs/v2/ontologies/models/ModifyInterfaceObjectRule.md index 0d36f471..76e77213 100644 --- a/docs/v2/ontologies/models/ModifyInterfaceObjectRule.md +++ b/docs/v2/ontologies/models/ModifyInterfaceObjectRule.md @@ -5,6 +5,7 @@ ModifyInterfaceObjectRule ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | +**interface_type_api_name** | InterfaceTypeApiName | Yes | | **type** | Literal["modifyInterfaceObject"] | Yes | None | diff --git a/docs/v2/ontologies/models/ModifyInterfaceObjectRuleDict.md b/docs/v2/ontologies/models/ModifyInterfaceObjectRuleDict.md index a3d79c40..3b5f50e3 100644 --- a/docs/v2/ontologies/models/ModifyInterfaceObjectRuleDict.md +++ b/docs/v2/ontologies/models/ModifyInterfaceObjectRuleDict.md @@ -5,6 +5,7 @@ ModifyInterfaceObjectRule ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | +**interfaceTypeApiName** | InterfaceTypeApiName | Yes | | **type** | Literal["modifyInterfaceObject"] | Yes | None | diff --git a/docs/v2/ontologies/models/OntologyInterfaceObjectType.md b/docs/v2/ontologies/models/OntologyInterfaceObjectType.md new file mode 100644 index 00000000..d0ae9ec2 --- /dev/null +++ b/docs/v2/ontologies/models/OntologyInterfaceObjectType.md @@ -0,0 +1,12 @@ +# OntologyInterfaceObjectType + +OntologyInterfaceObjectType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**interface_type_api_name** | InterfaceTypeApiName | Yes | | +**type** | Literal["interfaceObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/OntologyInterfaceObjectTypeDict.md b/docs/v2/ontologies/models/OntologyInterfaceObjectTypeDict.md new file mode 100644 index 00000000..b1406305 --- /dev/null +++ b/docs/v2/ontologies/models/OntologyInterfaceObjectTypeDict.md @@ -0,0 +1,12 @@ +# OntologyInterfaceObjectTypeDict + +OntologyInterfaceObjectType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**interfaceTypeApiName** | InterfaceTypeApiName | Yes | | +**type** | Literal["interfaceObject"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/OntologyObjectTypeReferenceType.md b/docs/v2/ontologies/models/OntologyObjectTypeReferenceType.md new file mode 100644 index 00000000..9fdc02c4 --- /dev/null +++ b/docs/v2/ontologies/models/OntologyObjectTypeReferenceType.md @@ -0,0 +1,11 @@ +# OntologyObjectTypeReferenceType + +OntologyObjectTypeReferenceType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["objectType"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/OntologyObjectTypeReferenceTypeDict.md b/docs/v2/ontologies/models/OntologyObjectTypeReferenceTypeDict.md new file mode 100644 index 00000000..bca273b7 --- /dev/null +++ b/docs/v2/ontologies/models/OntologyObjectTypeReferenceTypeDict.md @@ -0,0 +1,11 @@ +# OntologyObjectTypeReferenceTypeDict + +OntologyObjectTypeReferenceType + +## Properties +| Name | Type | Required | Description | +| ------------ | ------------- | ------------- | ------------- | +**type** | Literal["objectType"] | Yes | None | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/PropertyTypeStatus.md b/docs/v2/ontologies/models/PropertyTypeStatus.md new file mode 100644 index 00000000..19ea2950 --- /dev/null +++ b/docs/v2/ontologies/models/PropertyTypeStatus.md @@ -0,0 +1,19 @@ +# PropertyTypeStatus + +The status to indicate whether the PropertyType is either Experimental, Active, Deprecated, or Example. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +DeprecatedPropertyTypeStatus | deprecated +ActivePropertyTypeStatus | active +ExperimentalPropertyTypeStatus | experimental +ExamplePropertyTypeStatus | example + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/PropertyTypeStatusDict.md b/docs/v2/ontologies/models/PropertyTypeStatusDict.md new file mode 100644 index 00000000..e5c9906c --- /dev/null +++ b/docs/v2/ontologies/models/PropertyTypeStatusDict.md @@ -0,0 +1,19 @@ +# PropertyTypeStatusDict + +The status to indicate whether the PropertyType is either Experimental, Active, Deprecated, or Example. + + +This is a discriminator type and does not contain any fields. Instead, it is a union +of of the models listed below. + +This discriminator class uses the `type` field to differentiate between classes. + +| Class | Value +| ------------ | ------------- +DeprecatedPropertyTypeStatusDict | deprecated +ActivePropertyTypeStatusDict | active +ExperimentalPropertyTypeStatusDict | experimental +ExamplePropertyTypeStatusDict | example + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/PropertyTypeVisibility.md b/docs/v2/ontologies/models/PropertyTypeVisibility.md new file mode 100644 index 00000000..8d931f61 --- /dev/null +++ b/docs/v2/ontologies/models/PropertyTypeVisibility.md @@ -0,0 +1,12 @@ +# PropertyTypeVisibility + +PropertyTypeVisibility + +| **Value** | +| --------- | +| `"NORMAL"` | +| `"PROMINENT"` | +| `"HIDDEN"` | + + +[[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/PropertyV2.md b/docs/v2/ontologies/models/PropertyV2.md index eee9c5a9..35ec6130 100644 --- a/docs/v2/ontologies/models/PropertyV2.md +++ b/docs/v2/ontologies/models/PropertyV2.md @@ -9,6 +9,8 @@ Details about some property of an object. **display_name** | Optional[DisplayName] | No | | **data_type** | ObjectPropertyType | Yes | | **rid** | PropertyTypeRid | Yes | | +**status** | Optional[PropertyTypeStatus] | No | | +**visibility** | Optional[PropertyTypeVisibility] | No | | [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/ontologies/models/PropertyV2Dict.md b/docs/v2/ontologies/models/PropertyV2Dict.md index 2de03345..a4699794 100644 --- a/docs/v2/ontologies/models/PropertyV2Dict.md +++ b/docs/v2/ontologies/models/PropertyV2Dict.md @@ -9,6 +9,8 @@ Details about some property of an object. **displayName** | NotRequired[DisplayName] | No | | **dataType** | ObjectPropertyTypeDict | Yes | | **rid** | PropertyTypeRid | Yes | | +**status** | NotRequired[PropertyTypeStatusDict] | No | | +**visibility** | NotRequired[PropertyTypeVisibility] | No | | [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/Build.md b/docs/v2/orchestration/models/Build.md index 0b09523d..81fbb525 100644 --- a/docs/v2/orchestration/models/Build.md +++ b/docs/v2/orchestration/models/Build.md @@ -5,7 +5,7 @@ Build ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**rid** | BuildRid | Yes | The RID of a build | +**rid** | BuildRid | Yes | The RID of a build. | **branch_name** | BranchName | Yes | The branch that the build is running on. | **created_time** | CreatedTime | Yes | The timestamp that the build was created. | **created_by** | CreatedBy | Yes | The user who created the build. | diff --git a/docs/v2/orchestration/models/BuildDict.md b/docs/v2/orchestration/models/BuildDict.md index ecc033c4..b06c7470 100644 --- a/docs/v2/orchestration/models/BuildDict.md +++ b/docs/v2/orchestration/models/BuildDict.md @@ -5,7 +5,7 @@ Build ## Properties | Name | Type | Required | Description | | ------------ | ------------- | ------------- | ------------- | -**rid** | BuildRid | Yes | The RID of a build | +**rid** | BuildRid | Yes | The RID of a build. | **branchName** | BranchName | Yes | The branch that the build is running on. | **createdTime** | CreatedTime | Yes | The timestamp that the build was created. | **createdBy** | CreatedBy | Yes | The user who created the build. | diff --git a/docs/v2/orchestration/models/BuildRid.md b/docs/v2/orchestration/models/BuildRid.md index 972d5a58..ccb43fff 100644 --- a/docs/v2/orchestration/models/BuildRid.md +++ b/docs/v2/orchestration/models/BuildRid.md @@ -1,6 +1,6 @@ # BuildRid -The RID of a build +The RID of a build. ## Type ```python diff --git a/docs/v2/orchestration/models/CreateScheduleRequestActionDict.md b/docs/v2/orchestration/models/CreateScheduleRequestActionDict.md index 5f8ba8eb..46ddfb25 100644 --- a/docs/v2/orchestration/models/CreateScheduleRequestActionDict.md +++ b/docs/v2/orchestration/models/CreateScheduleRequestActionDict.md @@ -12,7 +12,7 @@ CreateScheduleRequestAction **fallbackBranches** | NotRequired[FallbackBranches] | No | | **branchName** | NotRequired[BranchName] | No | The target branch the schedule should run on. | **notificationsEnabled** | NotRequired[NotificationsEnabled] | No | | -**target** | CreateScheduleRequestActionBuildTargetDict | Yes | | +**target** | CreateScheduleRequestBuildTargetDict | Yes | | [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/CreateScheduleRequestActionBuildTargetDict.md b/docs/v2/orchestration/models/CreateScheduleRequestBuildTargetDict.md similarity index 63% rename from docs/v2/orchestration/models/CreateScheduleRequestActionBuildTargetDict.md rename to docs/v2/orchestration/models/CreateScheduleRequestBuildTargetDict.md index 54c0483b..928c8a66 100644 --- a/docs/v2/orchestration/models/CreateScheduleRequestActionBuildTargetDict.md +++ b/docs/v2/orchestration/models/CreateScheduleRequestBuildTargetDict.md @@ -1,4 +1,4 @@ -# CreateScheduleRequestActionBuildTargetDict +# CreateScheduleRequestBuildTargetDict The targets of the build. @@ -9,9 +9,9 @@ This discriminator class uses the `type` field to differentiate between classes. | Class | Value | ------------ | ------------- -CreateScheduleRequestActionBuildTargetUpstreamTargetDict | upstream -CreateScheduleRequestActionBuildTargetManualTargetDict | manual -CreateScheduleRequestActionBuildTargetConnectingTargetDict | connecting +CreateScheduleRequestUpstreamTargetDict | upstream +CreateScheduleRequestManualTargetDict | manual +CreateScheduleRequestConnectingTargetDict | connecting [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/CreateScheduleRequestActionBuildTargetConnectingTargetDict.md b/docs/v2/orchestration/models/CreateScheduleRequestConnectingTargetDict.md similarity index 84% rename from docs/v2/orchestration/models/CreateScheduleRequestActionBuildTargetConnectingTargetDict.md rename to docs/v2/orchestration/models/CreateScheduleRequestConnectingTargetDict.md index 0857d58f..f97a8fcf 100644 --- a/docs/v2/orchestration/models/CreateScheduleRequestActionBuildTargetConnectingTargetDict.md +++ b/docs/v2/orchestration/models/CreateScheduleRequestConnectingTargetDict.md @@ -1,6 +1,6 @@ -# CreateScheduleRequestActionBuildTargetConnectingTargetDict +# CreateScheduleRequestConnectingTargetDict -CreateScheduleRequestActionBuildTargetConnectingTarget +CreateScheduleRequestConnectingTarget ## Properties | Name | Type | Required | Description | diff --git a/docs/v2/orchestration/models/CreateScheduleRequestActionBuildTargetManualTargetDict.md b/docs/v2/orchestration/models/CreateScheduleRequestManualTargetDict.md similarity index 77% rename from docs/v2/orchestration/models/CreateScheduleRequestActionBuildTargetManualTargetDict.md rename to docs/v2/orchestration/models/CreateScheduleRequestManualTargetDict.md index a6dcc519..060896c5 100644 --- a/docs/v2/orchestration/models/CreateScheduleRequestActionBuildTargetManualTargetDict.md +++ b/docs/v2/orchestration/models/CreateScheduleRequestManualTargetDict.md @@ -1,6 +1,6 @@ -# CreateScheduleRequestActionBuildTargetManualTargetDict +# CreateScheduleRequestManualTargetDict -CreateScheduleRequestActionBuildTargetManualTarget +CreateScheduleRequestManualTarget ## Properties | Name | Type | Required | Description | diff --git a/docs/v2/orchestration/models/CreateScheduleRequestScopeModeProjectScopeDict.md b/docs/v2/orchestration/models/CreateScheduleRequestProjectScopeDict.md similarity index 80% rename from docs/v2/orchestration/models/CreateScheduleRequestScopeModeProjectScopeDict.md rename to docs/v2/orchestration/models/CreateScheduleRequestProjectScopeDict.md index d0334691..ea8879cd 100644 --- a/docs/v2/orchestration/models/CreateScheduleRequestScopeModeProjectScopeDict.md +++ b/docs/v2/orchestration/models/CreateScheduleRequestProjectScopeDict.md @@ -1,6 +1,6 @@ -# CreateScheduleRequestScopeModeProjectScopeDict +# CreateScheduleRequestProjectScopeDict -CreateScheduleRequestScopeModeProjectScope +CreateScheduleRequestProjectScope ## Properties | Name | Type | Required | Description | diff --git a/docs/v2/orchestration/models/CreateScheduleRequestScopeModeDict.md b/docs/v2/orchestration/models/CreateScheduleRequestScopeModeDict.md index e951b4b2..a9a4ca11 100644 --- a/docs/v2/orchestration/models/CreateScheduleRequestScopeModeDict.md +++ b/docs/v2/orchestration/models/CreateScheduleRequestScopeModeDict.md @@ -9,8 +9,8 @@ This discriminator class uses the `type` field to differentiate between classes. | Class | Value | ------------ | ------------- -CreateScheduleRequestScopeModeProjectScopeDict | project -CreateScheduleRequestScopeModeUserScopeDict | user +CreateScheduleRequestProjectScopeDict | project +CreateScheduleRequestUserScopeDict | user [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/CreateScheduleRequestActionBuildTargetUpstreamTargetDict.md b/docs/v2/orchestration/models/CreateScheduleRequestUpstreamTargetDict.md similarity index 82% rename from docs/v2/orchestration/models/CreateScheduleRequestActionBuildTargetUpstreamTargetDict.md rename to docs/v2/orchestration/models/CreateScheduleRequestUpstreamTargetDict.md index d9c479be..0a97519c 100644 --- a/docs/v2/orchestration/models/CreateScheduleRequestActionBuildTargetUpstreamTargetDict.md +++ b/docs/v2/orchestration/models/CreateScheduleRequestUpstreamTargetDict.md @@ -1,6 +1,6 @@ -# CreateScheduleRequestActionBuildTargetUpstreamTargetDict +# CreateScheduleRequestUpstreamTargetDict -CreateScheduleRequestActionBuildTargetUpstreamTarget +CreateScheduleRequestUpstreamTarget ## Properties | Name | Type | Required | Description | diff --git a/docs/v2/orchestration/models/CreateScheduleRequestScopeModeUserScopeDict.md b/docs/v2/orchestration/models/CreateScheduleRequestUserScopeDict.md similarity index 79% rename from docs/v2/orchestration/models/CreateScheduleRequestScopeModeUserScopeDict.md rename to docs/v2/orchestration/models/CreateScheduleRequestUserScopeDict.md index 5dcfaf6c..ee2cdfb9 100644 --- a/docs/v2/orchestration/models/CreateScheduleRequestScopeModeUserScopeDict.md +++ b/docs/v2/orchestration/models/CreateScheduleRequestUserScopeDict.md @@ -1,6 +1,6 @@ -# CreateScheduleRequestScopeModeUserScopeDict +# CreateScheduleRequestUserScopeDict -CreateScheduleRequestScopeModeUserScope +CreateScheduleRequestUserScope ## Properties | Name | Type | Required | Description | diff --git a/docs/v2/orchestration/models/NotificationsEnabled.md b/docs/v2/orchestration/models/NotificationsEnabled.md index e7dc0b15..557b8e58 100644 --- a/docs/v2/orchestration/models/NotificationsEnabled.md +++ b/docs/v2/orchestration/models/NotificationsEnabled.md @@ -1,6 +1,7 @@ # NotificationsEnabled -Whether to receive a notification at the end of scheduled builds. +Whether to receive a notification at the end of the build. +The notification will be sent to the user that has performed the request. ## Type ```python diff --git a/docs/v2/orchestration/models/ReplaceScheduleRequestActionDict.md b/docs/v2/orchestration/models/ReplaceScheduleRequestActionDict.md index f3113fd9..fdfbf376 100644 --- a/docs/v2/orchestration/models/ReplaceScheduleRequestActionDict.md +++ b/docs/v2/orchestration/models/ReplaceScheduleRequestActionDict.md @@ -12,7 +12,7 @@ ReplaceScheduleRequestAction **fallbackBranches** | NotRequired[FallbackBranches] | No | | **branchName** | NotRequired[BranchName] | No | The target branch the schedule should run on. | **notificationsEnabled** | NotRequired[NotificationsEnabled] | No | | -**target** | ReplaceScheduleRequestActionBuildTargetDict | Yes | | +**target** | ReplaceScheduleRequestBuildTargetDict | Yes | | [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ReplaceScheduleRequestActionBuildTargetDict.md b/docs/v2/orchestration/models/ReplaceScheduleRequestBuildTargetDict.md similarity index 63% rename from docs/v2/orchestration/models/ReplaceScheduleRequestActionBuildTargetDict.md rename to docs/v2/orchestration/models/ReplaceScheduleRequestBuildTargetDict.md index c8e1e0e9..5eb81b55 100644 --- a/docs/v2/orchestration/models/ReplaceScheduleRequestActionBuildTargetDict.md +++ b/docs/v2/orchestration/models/ReplaceScheduleRequestBuildTargetDict.md @@ -1,4 +1,4 @@ -# ReplaceScheduleRequestActionBuildTargetDict +# ReplaceScheduleRequestBuildTargetDict The targets of the build. @@ -9,9 +9,9 @@ This discriminator class uses the `type` field to differentiate between classes. | Class | Value | ------------ | ------------- -ReplaceScheduleRequestActionBuildTargetUpstreamTargetDict | upstream -ReplaceScheduleRequestActionBuildTargetManualTargetDict | manual -ReplaceScheduleRequestActionBuildTargetConnectingTargetDict | connecting +ReplaceScheduleRequestUpstreamTargetDict | upstream +ReplaceScheduleRequestManualTargetDict | manual +ReplaceScheduleRequestConnectingTargetDict | connecting [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ReplaceScheduleRequestActionBuildTargetConnectingTargetDict.md b/docs/v2/orchestration/models/ReplaceScheduleRequestConnectingTargetDict.md similarity index 84% rename from docs/v2/orchestration/models/ReplaceScheduleRequestActionBuildTargetConnectingTargetDict.md rename to docs/v2/orchestration/models/ReplaceScheduleRequestConnectingTargetDict.md index e2d59a5c..f13977be 100644 --- a/docs/v2/orchestration/models/ReplaceScheduleRequestActionBuildTargetConnectingTargetDict.md +++ b/docs/v2/orchestration/models/ReplaceScheduleRequestConnectingTargetDict.md @@ -1,6 +1,6 @@ -# ReplaceScheduleRequestActionBuildTargetConnectingTargetDict +# ReplaceScheduleRequestConnectingTargetDict -ReplaceScheduleRequestActionBuildTargetConnectingTarget +ReplaceScheduleRequestConnectingTarget ## Properties | Name | Type | Required | Description | diff --git a/docs/v2/orchestration/models/ReplaceScheduleRequestActionBuildTargetManualTargetDict.md b/docs/v2/orchestration/models/ReplaceScheduleRequestManualTargetDict.md similarity index 77% rename from docs/v2/orchestration/models/ReplaceScheduleRequestActionBuildTargetManualTargetDict.md rename to docs/v2/orchestration/models/ReplaceScheduleRequestManualTargetDict.md index 5af72caa..02715925 100644 --- a/docs/v2/orchestration/models/ReplaceScheduleRequestActionBuildTargetManualTargetDict.md +++ b/docs/v2/orchestration/models/ReplaceScheduleRequestManualTargetDict.md @@ -1,6 +1,6 @@ -# ReplaceScheduleRequestActionBuildTargetManualTargetDict +# ReplaceScheduleRequestManualTargetDict -ReplaceScheduleRequestActionBuildTargetManualTarget +ReplaceScheduleRequestManualTarget ## Properties | Name | Type | Required | Description | diff --git a/docs/v2/orchestration/models/ReplaceScheduleRequestScopeModeProjectScopeDict.md b/docs/v2/orchestration/models/ReplaceScheduleRequestProjectScopeDict.md similarity index 79% rename from docs/v2/orchestration/models/ReplaceScheduleRequestScopeModeProjectScopeDict.md rename to docs/v2/orchestration/models/ReplaceScheduleRequestProjectScopeDict.md index 5031a9d7..ee5ee1cb 100644 --- a/docs/v2/orchestration/models/ReplaceScheduleRequestScopeModeProjectScopeDict.md +++ b/docs/v2/orchestration/models/ReplaceScheduleRequestProjectScopeDict.md @@ -1,6 +1,6 @@ -# ReplaceScheduleRequestScopeModeProjectScopeDict +# ReplaceScheduleRequestProjectScopeDict -ReplaceScheduleRequestScopeModeProjectScope +ReplaceScheduleRequestProjectScope ## Properties | Name | Type | Required | Description | diff --git a/docs/v2/orchestration/models/ReplaceScheduleRequestScopeModeDict.md b/docs/v2/orchestration/models/ReplaceScheduleRequestScopeModeDict.md index e66e1977..f9d8116e 100644 --- a/docs/v2/orchestration/models/ReplaceScheduleRequestScopeModeDict.md +++ b/docs/v2/orchestration/models/ReplaceScheduleRequestScopeModeDict.md @@ -9,8 +9,8 @@ This discriminator class uses the `type` field to differentiate between classes. | Class | Value | ------------ | ------------- -ReplaceScheduleRequestScopeModeProjectScopeDict | project -ReplaceScheduleRequestScopeModeUserScopeDict | user +ReplaceScheduleRequestProjectScopeDict | project +ReplaceScheduleRequestUserScopeDict | user [[Back to Model list]](../../../../README.md#models-v2-link) [[Back to API list]](../../../../README.md#apis-v2-link) [[Back to README]](../../../../README.md) diff --git a/docs/v2/orchestration/models/ReplaceScheduleRequestActionBuildTargetUpstreamTargetDict.md b/docs/v2/orchestration/models/ReplaceScheduleRequestUpstreamTargetDict.md similarity index 82% rename from docs/v2/orchestration/models/ReplaceScheduleRequestActionBuildTargetUpstreamTargetDict.md rename to docs/v2/orchestration/models/ReplaceScheduleRequestUpstreamTargetDict.md index 737e2812..a546bcef 100644 --- a/docs/v2/orchestration/models/ReplaceScheduleRequestActionBuildTargetUpstreamTargetDict.md +++ b/docs/v2/orchestration/models/ReplaceScheduleRequestUpstreamTargetDict.md @@ -1,6 +1,6 @@ -# ReplaceScheduleRequestActionBuildTargetUpstreamTargetDict +# ReplaceScheduleRequestUpstreamTargetDict -ReplaceScheduleRequestActionBuildTargetUpstreamTarget +ReplaceScheduleRequestUpstreamTarget ## Properties | Name | Type | Required | Description | diff --git a/docs/v2/orchestration/models/ReplaceScheduleRequestScopeModeUserScopeDict.md b/docs/v2/orchestration/models/ReplaceScheduleRequestUserScopeDict.md similarity index 78% rename from docs/v2/orchestration/models/ReplaceScheduleRequestScopeModeUserScopeDict.md rename to docs/v2/orchestration/models/ReplaceScheduleRequestUserScopeDict.md index 4632bf9a..acd23157 100644 --- a/docs/v2/orchestration/models/ReplaceScheduleRequestScopeModeUserScopeDict.md +++ b/docs/v2/orchestration/models/ReplaceScheduleRequestUserScopeDict.md @@ -1,6 +1,6 @@ -# ReplaceScheduleRequestScopeModeUserScopeDict +# ReplaceScheduleRequestUserScopeDict -ReplaceScheduleRequestScopeModeUserScope +ReplaceScheduleRequestUserScope ## Properties | Name | Type | Required | Description | diff --git a/foundry/_versions.py b/foundry/_versions.py index 874eec79..aec87ad7 100644 --- a/foundry/_versions.py +++ b/foundry/_versions.py @@ -17,4 +17,4 @@ # using the autorelease bot __version__ = "0.0.0" -__openapi_document_version__ = "1.983.0" +__openapi_document_version__ = "1.1002.0" diff --git a/foundry/v1/cli.py b/foundry/v1/cli.py index 3d46bc34..ee7aa51b 100644 --- a/foundry/v1/cli.py +++ b/foundry/v1/cli.py @@ -774,6 +774,11 @@ def geo(): pass +@cli.group("mediasets") +def mediasets(): + pass + + @cli.group("ontologies") def ontologies(): pass diff --git a/foundry/v1/mediasets/models/__init__.py b/foundry/v1/mediasets/models/__init__.py new file mode 100644 index 00000000..6dd5770f --- /dev/null +++ b/foundry/v1/mediasets/models/__init__.py @@ -0,0 +1,16 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +__all__ = [] diff --git a/foundry/v1/ontologies/models/__init__.py b/foundry/v1/ontologies/models/__init__.py index b2fe3a22..2a934451 100644 --- a/foundry/v1/ontologies/models/__init__.py +++ b/foundry/v1/ontologies/models/__init__.py @@ -82,6 +82,12 @@ from foundry.v1.ontologies.models._create_object_rule import CreateObjectRule from foundry.v1.ontologies.models._create_object_rule_dict import CreateObjectRuleDict from foundry.v1.ontologies.models._data_value import DataValue +from foundry.v1.ontologies.models._delete_interface_object_rule import ( + DeleteInterfaceObjectRule, +) # NOQA +from foundry.v1.ontologies.models._delete_interface_object_rule_dict import ( + DeleteInterfaceObjectRuleDict, +) # NOQA from foundry.v1.ontologies.models._delete_link_rule import DeleteLinkRule from foundry.v1.ontologies.models._delete_link_rule_dict import DeleteLinkRuleDict from foundry.v1.ontologies.models._delete_object_rule import DeleteObjectRule @@ -101,6 +107,7 @@ ) # NOQA from foundry.v1.ontologies.models._gt_query_dict import GtQueryDict from foundry.v1.ontologies.models._gte_query_dict import GteQueryDict +from foundry.v1.ontologies.models._interface_type_api_name import InterfaceTypeApiName from foundry.v1.ontologies.models._is_null_query_dict import IsNullQueryDict from foundry.v1.ontologies.models._link_type_api_name import LinkTypeApiName from foundry.v1.ontologies.models._link_type_side import LinkTypeSide @@ -306,6 +313,8 @@ "CreateObjectRule", "CreateObjectRuleDict", "DataValue", + "DeleteInterfaceObjectRule", + "DeleteInterfaceObjectRuleDict", "DeleteLinkRule", "DeleteLinkRuleDict", "DeleteObjectRule", @@ -321,6 +330,7 @@ "GroupMemberConstraintDict", "GtQueryDict", "GteQueryDict", + "InterfaceTypeApiName", "IsNullQueryDict", "LinkTypeApiName", "LinkTypeSide", diff --git a/foundry/v1/ontologies/models/_create_interface_object_rule.py b/foundry/v1/ontologies/models/_create_interface_object_rule.py index e507402f..2879f6ec 100644 --- a/foundry/v1/ontologies/models/_create_interface_object_rule.py +++ b/foundry/v1/ontologies/models/_create_interface_object_rule.py @@ -23,11 +23,14 @@ from foundry.v1.ontologies.models._create_interface_object_rule_dict import ( CreateInterfaceObjectRuleDict, ) # NOQA +from foundry.v1.ontologies.models._interface_type_api_name import InterfaceTypeApiName class CreateInterfaceObjectRule(pydantic.BaseModel): """CreateInterfaceObjectRule""" + interface_type_api_name: InterfaceTypeApiName = pydantic.Field(alias="interfaceTypeApiName") + type: Literal["createInterfaceObject"] = "createInterfaceObject" model_config = {"extra": "allow"} diff --git a/foundry/v1/ontologies/models/_create_interface_object_rule_dict.py b/foundry/v1/ontologies/models/_create_interface_object_rule_dict.py index 37803055..cfb02860 100644 --- a/foundry/v1/ontologies/models/_create_interface_object_rule_dict.py +++ b/foundry/v1/ontologies/models/_create_interface_object_rule_dict.py @@ -19,10 +19,14 @@ from typing_extensions import TypedDict +from foundry.v1.ontologies.models._interface_type_api_name import InterfaceTypeApiName + class CreateInterfaceObjectRuleDict(TypedDict): """CreateInterfaceObjectRule""" __pydantic_config__ = {"extra": "allow"} # type: ignore + interfaceTypeApiName: InterfaceTypeApiName + type: Literal["createInterfaceObject"] diff --git a/foundry/v1/ontologies/models/_delete_interface_object_rule.py b/foundry/v1/ontologies/models/_delete_interface_object_rule.py new file mode 100644 index 00000000..ae5e645e --- /dev/null +++ b/foundry/v1/ontologies/models/_delete_interface_object_rule.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +import pydantic + +from foundry.v1.ontologies.models._delete_interface_object_rule_dict import ( + DeleteInterfaceObjectRuleDict, +) # NOQA +from foundry.v1.ontologies.models._interface_type_api_name import InterfaceTypeApiName + + +class DeleteInterfaceObjectRule(pydantic.BaseModel): + """DeleteInterfaceObjectRule""" + + interface_type_api_name: InterfaceTypeApiName = pydantic.Field(alias="interfaceTypeApiName") + + type: Literal["deleteInterfaceObject"] = "deleteInterfaceObject" + + model_config = {"extra": "allow"} + + def to_dict(self) -> DeleteInterfaceObjectRuleDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + DeleteInterfaceObjectRuleDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v1/ontologies/models/_delete_interface_object_rule_dict.py b/foundry/v1/ontologies/models/_delete_interface_object_rule_dict.py new file mode 100644 index 00000000..ceda5264 --- /dev/null +++ b/foundry/v1/ontologies/models/_delete_interface_object_rule_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v1.ontologies.models._interface_type_api_name import InterfaceTypeApiName + + +class DeleteInterfaceObjectRuleDict(TypedDict): + """DeleteInterfaceObjectRule""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + interfaceTypeApiName: InterfaceTypeApiName + + type: Literal["deleteInterfaceObject"] diff --git a/foundry/v1/ontologies/models/_interface_type_api_name.py b/foundry/v1/ontologies/models/_interface_type_api_name.py new file mode 100644 index 00000000..71963298 --- /dev/null +++ b/foundry/v1/ontologies/models/_interface_type_api_name.py @@ -0,0 +1,24 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +import pydantic + +InterfaceTypeApiName = pydantic.StrictStr +""" +The name of the interface type in the API in UpperCamelCase format. To find the API name for your interface +type, use the `List interface types` endpoint or check the **Ontology Manager**. +""" diff --git a/foundry/v1/ontologies/models/_logic_rule.py b/foundry/v1/ontologies/models/_logic_rule.py index ca57647c..97357d36 100644 --- a/foundry/v1/ontologies/models/_logic_rule.py +++ b/foundry/v1/ontologies/models/_logic_rule.py @@ -25,6 +25,9 @@ ) # NOQA from foundry.v1.ontologies.models._create_link_rule import CreateLinkRule from foundry.v1.ontologies.models._create_object_rule import CreateObjectRule +from foundry.v1.ontologies.models._delete_interface_object_rule import ( + DeleteInterfaceObjectRule, +) # NOQA from foundry.v1.ontologies.models._delete_link_rule import DeleteLinkRule from foundry.v1.ontologies.models._delete_object_rule import DeleteObjectRule from foundry.v1.ontologies.models._modify_interface_object_rule import ( @@ -34,6 +37,7 @@ LogicRule = Annotated[ Union[ + DeleteInterfaceObjectRule, ModifyInterfaceObjectRule, ModifyObjectRule, DeleteObjectRule, diff --git a/foundry/v1/ontologies/models/_logic_rule_dict.py b/foundry/v1/ontologies/models/_logic_rule_dict.py index 36c1a6f7..b4c64c91 100644 --- a/foundry/v1/ontologies/models/_logic_rule_dict.py +++ b/foundry/v1/ontologies/models/_logic_rule_dict.py @@ -25,6 +25,9 @@ ) # NOQA from foundry.v1.ontologies.models._create_link_rule_dict import CreateLinkRuleDict from foundry.v1.ontologies.models._create_object_rule_dict import CreateObjectRuleDict +from foundry.v1.ontologies.models._delete_interface_object_rule_dict import ( + DeleteInterfaceObjectRuleDict, +) # NOQA from foundry.v1.ontologies.models._delete_link_rule_dict import DeleteLinkRuleDict from foundry.v1.ontologies.models._delete_object_rule_dict import DeleteObjectRuleDict from foundry.v1.ontologies.models._modify_interface_object_rule_dict import ( @@ -34,6 +37,7 @@ LogicRuleDict = Annotated[ Union[ + DeleteInterfaceObjectRuleDict, ModifyInterfaceObjectRuleDict, ModifyObjectRuleDict, DeleteObjectRuleDict, diff --git a/foundry/v1/ontologies/models/_modify_interface_object_rule.py b/foundry/v1/ontologies/models/_modify_interface_object_rule.py index bf47c020..3afa1dfe 100644 --- a/foundry/v1/ontologies/models/_modify_interface_object_rule.py +++ b/foundry/v1/ontologies/models/_modify_interface_object_rule.py @@ -20,6 +20,7 @@ import pydantic +from foundry.v1.ontologies.models._interface_type_api_name import InterfaceTypeApiName from foundry.v1.ontologies.models._modify_interface_object_rule_dict import ( ModifyInterfaceObjectRuleDict, ) # NOQA @@ -28,6 +29,8 @@ class ModifyInterfaceObjectRule(pydantic.BaseModel): """ModifyInterfaceObjectRule""" + interface_type_api_name: InterfaceTypeApiName = pydantic.Field(alias="interfaceTypeApiName") + type: Literal["modifyInterfaceObject"] = "modifyInterfaceObject" model_config = {"extra": "allow"} diff --git a/foundry/v1/ontologies/models/_modify_interface_object_rule_dict.py b/foundry/v1/ontologies/models/_modify_interface_object_rule_dict.py index 2ce1db20..e01a0626 100644 --- a/foundry/v1/ontologies/models/_modify_interface_object_rule_dict.py +++ b/foundry/v1/ontologies/models/_modify_interface_object_rule_dict.py @@ -19,10 +19,14 @@ from typing_extensions import TypedDict +from foundry.v1.ontologies.models._interface_type_api_name import InterfaceTypeApiName + class ModifyInterfaceObjectRuleDict(TypedDict): """ModifyInterfaceObjectRule""" __pydantic_config__ = {"extra": "allow"} # type: ignore + interfaceTypeApiName: InterfaceTypeApiName + type: Literal["modifyInterfaceObject"] diff --git a/foundry/v1/ontologies/models/_property_value.py b/foundry/v1/ontologies/models/_property_value.py index 6462a71e..ceec7291 100644 --- a/foundry/v1/ontologies/models/_property_value.py +++ b/foundry/v1/ontologies/models/_property_value.py @@ -21,23 +21,25 @@ """ Represents the value of a property in the following format. -| Type | JSON encoding | Example | -|----------- |-------------------------------------------------------|----------------------------------------------------------------------------------------------------| -| Array | array | `["alpha", "bravo", "charlie"]` | -| Attachment | JSON encoded `AttachmentProperty` object | `{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}` | -| Boolean | boolean | `true` | -| Byte | number | `31` | -| Date | ISO 8601 extended local date string | `"2021-05-01"` | -| Decimal | string | `"2.718281828"` | -| Double | number | `3.14159265` | -| Float | number | `3.14159265` | -| GeoPoint | geojson | `{"type":"Point","coordinates":[102.0,0.5]}` | -| GeoShape | geojson | `{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}` | -| Integer | number | `238940` | -| Long | string | `"58319870951433"` | -| Short | number | `8739` | -| String | string | `"Call me Ishmael"` | -| Timestamp | ISO 8601 extended offset date-time string in UTC zone | `"2021-01-04T05:00:00Z"` | +| Type | JSON encoding | Example | +|---------------- |-------------------------------------------------------------|----------------------------------------------------------------------------------------------------| +| Array | array | `["alpha", "bravo", "charlie"]` | +| Attachment | JSON encoded `AttachmentProperty` object | `{"rid":"ri.blobster.main.attachment.2f944bae-5851-4204-8615-920c969a9f2e"}` | +| Boolean | boolean | `true` | +| Byte | number | `31` | +| Date | ISO 8601 extended local date string | `"2021-05-01"` | +| Decimal | string | `"2.718281828"` | +| Double | number | `3.14159265` | +| Float | number | `3.14159265` | +| GeoPoint | geojson | `{"type":"Point","coordinates":[102.0,0.5]}` | +| GeoShape | geojson | `{"type":"LineString","coordinates":[[102.0,0.0],[103.0,1.0],[104.0,0.0],[105.0,1.0]]}` | +| Integer | number | `238940` | +| Long | string | `"58319870951433"` | +| MediaReference | JSON encoded `MediaReference` object | `{"mimeType":"application/pdf","reference":{"type":"mediaSetViewItem","mediaSetViewItem":{"mediaSetRid":"ri.mio.main.media-set.4153d42f-ca4b-4e42-8ca5-8e6aa7edb642","mediaSetViewRid":"ri.mio.main.view.82a798ad-d637-4595-acc6-987bcf16629b","mediaItemRid":"ri.mio.main.media-item.001ec98b-1620-4814-9e17-8e9c4e536225"}}}` | +| Short | number | `8739` | +| String | string | `"Call me Ishmael"` | +| Timestamp | ISO 8601 extended offset date-time string in UTC zone | `"2021-01-04T05:00:00Z"` | +| Timeseries | JSON encoded `TimeseriesProperty` object or seriesId string | `{"seriesId": "wellPressureSeriesId", "syncRid": ri.time-series-catalog.main.sync.04f5ac1f-91bf-44f9-a51f-4f34e06e42df"}` or `{"templateRid": "ri.codex-emu.main.template.367cac64-e53b-4653-b111-f61856a63df9", "templateVersion": "0.0.0"}` or `"wellPressureSeriesId"`| | Note that for backwards compatibility, the Boolean, Byte, Double, Float, Integer, and Short types can also be encoded as JSON strings. """ diff --git a/foundry/v2/cli.py b/foundry/v2/cli.py index 92790af6..2068be78 100644 --- a/foundry/v2/cli.py +++ b/foundry/v2/cli.py @@ -1417,6 +1417,15 @@ def connectivity_connection_update_secrets( Updates the secrets on the connection to the specified secret values. Secrets that are currently configured on the connection but are omitted in the request will remain unchanged. + Secrets are transmitted over the network encrypted using TLS. Once the secrets reach Foundry's servers, + they will be temporarily decrypted and remain in plaintext in memory to be processed as needed. + They will stay in plaintext in memory until the garbage collection process cleans up the memory. + The secrets are always stored encrypted on our servers. + + By using this endpoint, you acknowledge and accept any potential risks associated with the temporary + in-memory handling of secrets. If you do not want your secrets to be temporarily decrypted, you should + use the Foundry UI instead. + """ result = client.connectivity.Connection.update_secrets( connection_rid=connection_rid, @@ -1426,6 +1435,123 @@ def connectivity_connection_update_secrets( click.echo(repr(result)) +@connectivity_connection.group("table_import") +def connectivity_connection_table_import(): + pass + + +@connectivity_connection_table_import.command("create") +@click.argument("connection_rid", type=str, required=True) +@click.option("--config", type=str, required=True, help="""""") +@click.option("--dataset_rid", type=str, required=True, help="""The RID of the output dataset.""") +@click.option("--display_name", type=str, required=True, help="""""") +@click.option( + "--import_mode", type=click.Choice(["SNAPSHOT", "APPEND"]), required=True, help="""""" +) +@click.option( + "--branch_name", + type=str, + required=False, + help="""The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments.""", +) +@click.option("--preview", type=bool, required=False, help="""preview""") +@click.pass_obj +def connectivity_connection_table_import_create( + client: foundry.v2.FoundryClient, + connection_rid: str, + config: str, + dataset_rid: str, + display_name: str, + import_mode: Literal["SNAPSHOT", "APPEND"], + branch_name: Optional[str], + preview: Optional[bool], +): + """ + Creates a new TableImport. + """ + result = client.connectivity.Connection.TableImport.create( + connection_rid=connection_rid, + config=json.loads(config), + dataset_rid=dataset_rid, + display_name=display_name, + import_mode=import_mode, + branch_name=branch_name, + preview=preview, + ) + click.echo(repr(result)) + + +@connectivity_connection_table_import.command("delete") +@click.argument("connection_rid", type=str, required=True) +@click.argument("table_import_rid", type=str, required=True) +@click.option("--preview", type=bool, required=False, help="""preview""") +@click.pass_obj +def connectivity_connection_table_import_delete( + client: foundry.v2.FoundryClient, + connection_rid: str, + table_import_rid: str, + preview: Optional[bool], +): + """ + Delete the TableImport with the specified RID. + Deleting the table import does not delete the destination dataset but the dataset will no longer + be updated by this import. + + """ + result = client.connectivity.Connection.TableImport.delete( + connection_rid=connection_rid, + table_import_rid=table_import_rid, + preview=preview, + ) + click.echo(repr(result)) + + +@connectivity_connection_table_import.command("execute") +@click.argument("connection_rid", type=str, required=True) +@click.argument("table_import_rid", type=str, required=True) +@click.option("--preview", type=bool, required=False, help="""preview""") +@click.pass_obj +def connectivity_connection_table_import_execute( + client: foundry.v2.FoundryClient, + connection_rid: str, + table_import_rid: str, + preview: Optional[bool], +): + """ + Executes the TableImport, which runs asynchronously as a [Foundry Build](/docs/foundry/data-integration/builds/). + The returned BuildRid can be used to check the status via the Orchestration API. + + """ + result = client.connectivity.Connection.TableImport.execute( + connection_rid=connection_rid, + table_import_rid=table_import_rid, + preview=preview, + ) + click.echo(repr(result)) + + +@connectivity_connection_table_import.command("get") +@click.argument("connection_rid", type=str, required=True) +@click.argument("table_import_rid", type=str, required=True) +@click.option("--preview", type=bool, required=False, help="""preview""") +@click.pass_obj +def connectivity_connection_table_import_get( + client: foundry.v2.FoundryClient, + connection_rid: str, + table_import_rid: str, + preview: Optional[bool], +): + """ + Get the TableImport with the specified rid. + """ + result = client.connectivity.Connection.TableImport.get( + connection_rid=connection_rid, + table_import_rid=table_import_rid, + preview=preview, + ) + click.echo(repr(result)) + + @connectivity_connection.group("file_import") def connectivity_connection_file_import(): pass @@ -1607,6 +1733,63 @@ def connectivity_connection_file_import_page( click.echo(repr(result)) +@connectivity_connection_file_import.command("replace") +@click.argument("connection_rid", type=str, required=True) +@click.argument("file_import_rid", type=str, required=True) +@click.option("--dataset_rid", type=str, required=True, help="""The RID of the output dataset.""") +@click.option("--display_name", type=str, required=True, help="""""") +@click.option( + "--file_import_filters", + type=str, + required=True, + help="""Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs)""", +) +@click.option( + "--import_mode", type=click.Choice(["SNAPSHOT", "APPEND", "UPDATE"]), required=True, help="""""" +) +@click.option( + "--branch_name", + type=str, + required=False, + help="""The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments.""", +) +@click.option("--preview", type=bool, required=False, help="""preview""") +@click.option( + "--subfolder", + type=str, + required=False, + help="""A subfolder in the external system that will be imported. If not specified, defaults to the root folder of the external system.""", +) +@click.pass_obj +def connectivity_connection_file_import_replace( + client: foundry.v2.FoundryClient, + connection_rid: str, + file_import_rid: str, + dataset_rid: str, + display_name: str, + file_import_filters: str, + import_mode: Literal["SNAPSHOT", "APPEND", "UPDATE"], + branch_name: Optional[str], + preview: Optional[bool], + subfolder: Optional[str], +): + """ + Replace the FileImport with the specified rid. + """ + result = client.connectivity.Connection.FileImport.replace( + connection_rid=connection_rid, + file_import_rid=file_import_rid, + dataset_rid=dataset_rid, + display_name=display_name, + file_import_filters=json.loads(file_import_filters), + import_mode=import_mode, + branch_name=branch_name, + preview=preview, + subfolder=subfolder, + ) + click.echo(repr(result)) + + @cli.group("core") def core(): pass @@ -1680,7 +1863,7 @@ def datasets_dataset_read_table( """ Gets the content of a dataset as a table in the specified format. - This endpoint currently does not support views (Virtual datasets composed of other datasets). + This endpoint currently does not support views (virtual datasets composed of other datasets). """ result = client.datasets.Dataset.read_table( @@ -2550,6 +2733,11 @@ def geo(): pass +@cli.group("mediasets") +def mediasets(): + pass + + @cli.group("ontologies") def ontologies(): pass @@ -4351,6 +4539,26 @@ def orchestration_build(): pass +@orchestration_build.command("cancel") +@click.argument("build_rid", type=str, required=True) +@click.option("--preview", type=bool, required=False, help="""preview""") +@click.pass_obj +def orchestration_build_cancel( + client: foundry.v2.FoundryClient, + build_rid: str, + preview: Optional[bool], +): + """ + Request a cancellation for all unfinished jobs in a build. The build's status will not update immediately. This endpoint is asynchronous and a success response indicates that the cancellation request has been acknowledged and the build is expected to be canceled soon. If the build has already finished or finishes shortly after the request and before the cancellation, the build will not change. + + """ + result = client.orchestration.Build.cancel( + build_rid=build_rid, + preview=preview, + ) + click.echo(repr(result)) + + @orchestration_build.command("create") @click.option("--fallback_branches", type=str, required=True, help="""""") @click.option("--target", type=str, required=True, help="""The targets of the schedule.""") @@ -4359,7 +4567,13 @@ def orchestration_build(): "--branch_name", type=str, required=False, help="""The target branch the build should run on.""" ) @click.option("--force_build", type=bool, required=False, help="""""") -@click.option("--notifications_enabled", type=bool, required=False, help="""""") +@click.option( + "--notifications_enabled", + type=bool, + required=False, + help="""The notification will be sent to the user that has most recently edited the schedule. +No notification will be sent if the schedule has `scopeMode` set to `ProjectScope`.""", +) @click.option("--preview", type=bool, required=False, help="""preview""") @click.option("--retry_backoff_duration", type=str, required=False, help="""""") @click.option( diff --git a/foundry/v2/connectivity/connection.py b/foundry/v2/connectivity/connection.py index 5a9230ba..f07f7a01 100644 --- a/foundry/v2/connectivity/connection.py +++ b/foundry/v2/connectivity/connection.py @@ -32,6 +32,7 @@ from foundry.v2.connectivity.models._connection_rid import ConnectionRid from foundry.v2.connectivity.models._plaintext_value import PlaintextValue from foundry.v2.connectivity.models._secret_name import SecretName +from foundry.v2.connectivity.table_import import TableImportClient from foundry.v2.core.models._preview_mode import PreviewMode @@ -40,6 +41,7 @@ def __init__(self, auth: Auth, hostname: str) -> None: self._api_client = ApiClient(auth=auth, hostname=hostname) self.FileImport = FileImportClient(auth=auth, hostname=hostname) + self.TableImport = TableImportClient(auth=auth, hostname=hostname) @pydantic.validate_call @handle_unexpected @@ -96,6 +98,15 @@ def update_secrets( Updates the secrets on the connection to the specified secret values. Secrets that are currently configured on the connection but are omitted in the request will remain unchanged. + Secrets are transmitted over the network encrypted using TLS. Once the secrets reach Foundry's servers, + they will be temporarily decrypted and remain in plaintext in memory to be processed as needed. + They will stay in plaintext in memory until the garbage collection process cleans up the memory. + The secrets are always stored encrypted on our servers. + + By using this endpoint, you acknowledge and accept any potential risks associated with the temporary + in-memory handling of secrets. If you do not want your secrets to be temporarily decrypted, you should + use the Foundry UI instead. + :param connection_rid: connectionRid :type connection_rid: ConnectionRid :param secrets: The secrets to be updated. The specified secret names must already be configured on the connection. diff --git a/foundry/v2/connectivity/file_import.py b/foundry/v2/connectivity/file_import.py index 9896a8da..5f19f7c0 100644 --- a/foundry/v2/connectivity/file_import.py +++ b/foundry/v2/connectivity/file_import.py @@ -362,3 +362,84 @@ def page( request_timeout=request_timeout, ), ) + + @pydantic.validate_call + @handle_unexpected + def replace( + self, + connection_rid: ConnectionRid, + file_import_rid: FileImportRid, + *, + dataset_rid: DatasetRid, + display_name: FileImportDisplayName, + file_import_filters: List[FileImportFilterDict], + import_mode: FileImportMode, + branch_name: Optional[BranchName] = None, + preview: Optional[PreviewMode] = None, + subfolder: Optional[pydantic.StrictStr] = None, + request_timeout: Optional[Annotated[pydantic.StrictInt, pydantic.Field(gt=0)]] = None, + ) -> FileImport: + """ + Replace the FileImport with the specified rid. + :param connection_rid: connectionRid + :type connection_rid: ConnectionRid + :param file_import_rid: fileImportRid + :type file_import_rid: FileImportRid + :param dataset_rid: The RID of the output dataset. + :type dataset_rid: DatasetRid + :param display_name: + :type display_name: FileImportDisplayName + :param file_import_filters: Use filters to limit which files should be imported. Filters are applied in the order they are defined. A different ordering of filters may lead to a more optimized import. [Learn more about optimizing file imports.](/docs/foundry/data-connection/file-based-syncs/#optimize-file-based-syncs) + :type file_import_filters: List[FileImportFilterDict] + :param import_mode: + :type import_mode: FileImportMode + :param branch_name: The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. + :type branch_name: Optional[BranchName] + :param preview: preview + :type preview: Optional[PreviewMode] + :param subfolder: A subfolder in the external system that will be imported. If not specified, defaults to the root folder of the external system. + :type subfolder: Optional[pydantic.StrictStr] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: FileImport + """ + + return self._api_client.call_api( + RequestInfo( + method="PUT", + resource_path="/v2/connectivity/connections/{connectionRid}/fileImports/{fileImportRid}", + query_params={ + "preview": preview, + }, + path_params={ + "connectionRid": connection_rid, + "fileImportRid": file_import_rid, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "datasetRid": dataset_rid, + "importMode": import_mode, + "displayName": display_name, + "branchName": branch_name, + "subfolder": subfolder, + "fileImportFilters": file_import_filters, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "datasetRid": DatasetRid, + "importMode": FileImportMode, + "displayName": FileImportDisplayName, + "branchName": Optional[BranchName], + "subfolder": Optional[pydantic.StrictStr], + "fileImportFilters": List[FileImportFilterDict], + }, + ), + response_type=FileImport, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/connectivity/models/__init__.py b/foundry/v2/connectivity/models/__init__.py index e4d522cf..d9f4aeff 100644 --- a/foundry/v2/connectivity/models/__init__.py +++ b/foundry/v2/connectivity/models/__init__.py @@ -24,6 +24,9 @@ from foundry.v2.connectivity.models._as_secret_name_dict import AsSecretNameDict from foundry.v2.connectivity.models._aws_access_key import AwsAccessKey from foundry.v2.connectivity.models._aws_access_key_dict import AwsAccessKeyDict +from foundry.v2.connectivity.models._cloud_identity import CloudIdentity +from foundry.v2.connectivity.models._cloud_identity_dict import CloudIdentityDict +from foundry.v2.connectivity.models._cloud_identity_rid import CloudIdentityRid from foundry.v2.connectivity.models._connection import Connection from foundry.v2.connectivity.models._connection_configuration import ConnectionConfiguration # NOQA from foundry.v2.connectivity.models._connection_configuration_dict import ( @@ -32,6 +35,24 @@ from foundry.v2.connectivity.models._connection_dict import ConnectionDict from foundry.v2.connectivity.models._connection_display_name import ConnectionDisplayName # NOQA from foundry.v2.connectivity.models._connection_rid import ConnectionRid +from foundry.v2.connectivity.models._create_table_import_request_jdbc_import_config_dict import ( + CreateTableImportRequestJdbcImportConfigDict, +) # NOQA +from foundry.v2.connectivity.models._create_table_import_request_microsoft_access_import_config_dict import ( + CreateTableImportRequestMicrosoftAccessImportConfigDict, +) # NOQA +from foundry.v2.connectivity.models._create_table_import_request_microsoft_sql_server_import_config_dict import ( + CreateTableImportRequestMicrosoftSqlServerImportConfigDict, +) # NOQA +from foundry.v2.connectivity.models._create_table_import_request_oracle_import_config_dict import ( + CreateTableImportRequestOracleImportConfigDict, +) # NOQA +from foundry.v2.connectivity.models._create_table_import_request_postgre_sql_import_config_dict import ( + CreateTableImportRequestPostgreSqlImportConfigDict, +) # NOQA +from foundry.v2.connectivity.models._create_table_import_request_table_import_config_dict import ( + CreateTableImportRequestTableImportConfigDict, +) # NOQA from foundry.v2.connectivity.models._direct_connection_runtime import ( DirectConnectionRuntime, ) # NOQA @@ -92,14 +113,36 @@ from foundry.v2.connectivity.models._files_count_limit_filter_dict import ( FilesCountLimitFilterDict, ) # NOQA +from foundry.v2.connectivity.models._jdbc_import_config import JdbcImportConfig +from foundry.v2.connectivity.models._jdbc_import_config_dict import JdbcImportConfigDict from foundry.v2.connectivity.models._list_file_imports_response import ( ListFileImportsResponse, ) # NOQA from foundry.v2.connectivity.models._list_file_imports_response_dict import ( ListFileImportsResponseDict, ) # NOQA +from foundry.v2.connectivity.models._microsoft_access_import_config import ( + MicrosoftAccessImportConfig, +) # NOQA +from foundry.v2.connectivity.models._microsoft_access_import_config_dict import ( + MicrosoftAccessImportConfigDict, +) # NOQA +from foundry.v2.connectivity.models._microsoft_sql_server_import_config import ( + MicrosoftSqlServerImportConfig, +) # NOQA +from foundry.v2.connectivity.models._microsoft_sql_server_import_config_dict import ( + MicrosoftSqlServerImportConfigDict, +) # NOQA from foundry.v2.connectivity.models._network_egress_policy_rid import NetworkEgressPolicyRid # NOQA +from foundry.v2.connectivity.models._oidc import Oidc +from foundry.v2.connectivity.models._oidc_dict import OidcDict +from foundry.v2.connectivity.models._oracle_import_config import OracleImportConfig +from foundry.v2.connectivity.models._oracle_import_config_dict import OracleImportConfigDict # NOQA from foundry.v2.connectivity.models._plaintext_value import PlaintextValue +from foundry.v2.connectivity.models._postgre_sql_import_config import PostgreSqlImportConfig # NOQA +from foundry.v2.connectivity.models._postgre_sql_import_config_dict import ( + PostgreSqlImportConfigDict, +) # NOQA from foundry.v2.connectivity.models._runtime_platform import RuntimePlatform from foundry.v2.connectivity.models._runtime_platform_dict import RuntimePlatformDict from foundry.v2.connectivity.models._s3_authentication_mode import S3AuthenticationMode @@ -113,6 +156,13 @@ S3ConnectionConfigurationDict, ) # NOQA from foundry.v2.connectivity.models._secret_name import SecretName +from foundry.v2.connectivity.models._table_import import TableImport +from foundry.v2.connectivity.models._table_import_config import TableImportConfig +from foundry.v2.connectivity.models._table_import_config_dict import TableImportConfigDict # NOQA +from foundry.v2.connectivity.models._table_import_dict import TableImportDict +from foundry.v2.connectivity.models._table_import_display_name import TableImportDisplayName # NOQA +from foundry.v2.connectivity.models._table_import_mode import TableImportMode +from foundry.v2.connectivity.models._table_import_rid import TableImportRid __all__ = [ "AgentProxyRuntime", @@ -126,12 +176,21 @@ "AsSecretNameDict", "AwsAccessKey", "AwsAccessKeyDict", + "CloudIdentity", + "CloudIdentityDict", + "CloudIdentityRid", "Connection", "ConnectionConfiguration", "ConnectionConfigurationDict", "ConnectionDict", "ConnectionDisplayName", "ConnectionRid", + "CreateTableImportRequestJdbcImportConfigDict", + "CreateTableImportRequestMicrosoftAccessImportConfigDict", + "CreateTableImportRequestMicrosoftSqlServerImportConfigDict", + "CreateTableImportRequestOracleImportConfigDict", + "CreateTableImportRequestPostgreSqlImportConfigDict", + "CreateTableImportRequestTableImportConfigDict", "DirectConnectionRuntime", "DirectConnectionRuntimeDict", "EncryptedProperty", @@ -162,10 +221,22 @@ "FileSizeFilterDict", "FilesCountLimitFilter", "FilesCountLimitFilterDict", + "JdbcImportConfig", + "JdbcImportConfigDict", "ListFileImportsResponse", "ListFileImportsResponseDict", + "MicrosoftAccessImportConfig", + "MicrosoftAccessImportConfigDict", + "MicrosoftSqlServerImportConfig", + "MicrosoftSqlServerImportConfigDict", "NetworkEgressPolicyRid", + "Oidc", + "OidcDict", + "OracleImportConfig", + "OracleImportConfigDict", "PlaintextValue", + "PostgreSqlImportConfig", + "PostgreSqlImportConfigDict", "RuntimePlatform", "RuntimePlatformDict", "S3AuthenticationMode", @@ -173,4 +244,11 @@ "S3ConnectionConfiguration", "S3ConnectionConfigurationDict", "SecretName", + "TableImport", + "TableImportConfig", + "TableImportConfigDict", + "TableImportDict", + "TableImportDisplayName", + "TableImportMode", + "TableImportRid", ] diff --git a/foundry/v2/connectivity/models/_cloud_identity.py b/foundry/v2/connectivity/models/_cloud_identity.py new file mode 100644 index 00000000..d68d6bab --- /dev/null +++ b/foundry/v2/connectivity/models/_cloud_identity.py @@ -0,0 +1,41 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +import pydantic + +from foundry.v2.connectivity.models._cloud_identity_dict import CloudIdentityDict +from foundry.v2.connectivity.models._cloud_identity_rid import CloudIdentityRid + + +class CloudIdentity(pydantic.BaseModel): + """ + [Cloud identities](/docs/foundry/administration/configure-cloud-identities/) allow you to authenticate to + cloud provider resources without the use of static credentials. + """ + + cloud_identity_rid: CloudIdentityRid = pydantic.Field(alias="cloudIdentityRid") + + type: Literal["cloudIdentity"] = "cloudIdentity" + + model_config = {"extra": "allow"} + + def to_dict(self) -> CloudIdentityDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(CloudIdentityDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/connectivity/models/_cloud_identity_dict.py b/foundry/v2/connectivity/models/_cloud_identity_dict.py new file mode 100644 index 00000000..3730ceda --- /dev/null +++ b/foundry/v2/connectivity/models/_cloud_identity_dict.py @@ -0,0 +1,35 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.connectivity.models._cloud_identity_rid import CloudIdentityRid + + +class CloudIdentityDict(TypedDict): + """ + [Cloud identities](/docs/foundry/administration/configure-cloud-identities/) allow you to authenticate to + cloud provider resources without the use of static credentials. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + cloudIdentityRid: CloudIdentityRid + + type: Literal["cloudIdentity"] diff --git a/foundry/v2/connectivity/models/_cloud_identity_rid.py b/foundry/v2/connectivity/models/_cloud_identity_rid.py new file mode 100644 index 00000000..2313cd95 --- /dev/null +++ b/foundry/v2/connectivity/models/_cloud_identity_rid.py @@ -0,0 +1,21 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from foundry._core.utils import RID + +CloudIdentityRid = RID +"""The Resource Identifier (RID) of a Cloud Identity.""" diff --git a/foundry/v2/connectivity/models/_connection.py b/foundry/v2/connectivity/models/_connection.py index 6e9c6301..ec70f71c 100644 --- a/foundry/v2/connectivity/models/_connection.py +++ b/foundry/v2/connectivity/models/_connection.py @@ -24,6 +24,7 @@ from foundry.v2.connectivity.models._connection_display_name import ConnectionDisplayName # NOQA from foundry.v2.connectivity.models._connection_rid import ConnectionRid from foundry.v2.connectivity.models._runtime_platform import RuntimePlatform +from foundry.v2.filesystem.models._folder_rid import FolderRid class Connection(pydantic.BaseModel): @@ -31,6 +32,8 @@ class Connection(pydantic.BaseModel): rid: ConnectionRid + parent_folder_rid: FolderRid = pydantic.Field(alias="parentFolderRid") + display_name: ConnectionDisplayName = pydantic.Field(alias="displayName") runtime_platform: RuntimePlatform = pydantic.Field(alias="runtimePlatform") diff --git a/foundry/v2/connectivity/models/_connection_dict.py b/foundry/v2/connectivity/models/_connection_dict.py index e8ec6da0..90f1a81e 100644 --- a/foundry/v2/connectivity/models/_connection_dict.py +++ b/foundry/v2/connectivity/models/_connection_dict.py @@ -23,6 +23,7 @@ from foundry.v2.connectivity.models._connection_display_name import ConnectionDisplayName # NOQA from foundry.v2.connectivity.models._connection_rid import ConnectionRid from foundry.v2.connectivity.models._runtime_platform_dict import RuntimePlatformDict +from foundry.v2.filesystem.models._folder_rid import FolderRid class ConnectionDict(TypedDict): @@ -32,6 +33,8 @@ class ConnectionDict(TypedDict): rid: ConnectionRid + parentFolderRid: FolderRid + displayName: ConnectionDisplayName runtimePlatform: RuntimePlatformDict diff --git a/foundry/v2/connectivity/models/_create_table_import_request_jdbc_import_config_dict.py b/foundry/v2/connectivity/models/_create_table_import_request_jdbc_import_config_dict.py new file mode 100644 index 00000000..e1faa3a1 --- /dev/null +++ b/foundry/v2/connectivity/models/_create_table_import_request_jdbc_import_config_dict.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +import pydantic +from typing_extensions import TypedDict + + +class CreateTableImportRequestJdbcImportConfigDict(TypedDict): + """CreateTableImportRequestJdbcImportConfig""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + query: pydantic.StrictStr + """ + A single SQL query can be executed per sync, which should output a data table + and avoid operations like invoking stored procedures. + The query results are saved to the output dataset in Foundry. + """ + + type: Literal["jdbcImportConfig"] diff --git a/foundry/v2/connectivity/models/_create_table_import_request_microsoft_access_import_config_dict.py b/foundry/v2/connectivity/models/_create_table_import_request_microsoft_access_import_config_dict.py new file mode 100644 index 00000000..3d4056f1 --- /dev/null +++ b/foundry/v2/connectivity/models/_create_table_import_request_microsoft_access_import_config_dict.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +import pydantic +from typing_extensions import TypedDict + + +class CreateTableImportRequestMicrosoftAccessImportConfigDict(TypedDict): + """CreateTableImportRequestMicrosoftAccessImportConfig""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + query: pydantic.StrictStr + """ + A single SQL query can be executed per sync, which should output a data table + and avoid operations like invoking stored procedures. + The query results are saved to the output dataset in Foundry. + """ + + type: Literal["microsoftAccessImportConfig"] diff --git a/foundry/v2/connectivity/models/_create_table_import_request_microsoft_sql_server_import_config_dict.py b/foundry/v2/connectivity/models/_create_table_import_request_microsoft_sql_server_import_config_dict.py new file mode 100644 index 00000000..f5e991f0 --- /dev/null +++ b/foundry/v2/connectivity/models/_create_table_import_request_microsoft_sql_server_import_config_dict.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +import pydantic +from typing_extensions import TypedDict + + +class CreateTableImportRequestMicrosoftSqlServerImportConfigDict(TypedDict): + """CreateTableImportRequestMicrosoftSqlServerImportConfig""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + query: pydantic.StrictStr + """ + A single SQL query can be executed per sync, which should output a data table + and avoid operations like invoking stored procedures. + The query results are saved to the output dataset in Foundry. + """ + + type: Literal["microsoftSqlServerImportConfig"] diff --git a/foundry/v2/connectivity/models/_create_table_import_request_oracle_import_config_dict.py b/foundry/v2/connectivity/models/_create_table_import_request_oracle_import_config_dict.py new file mode 100644 index 00000000..ed1114e9 --- /dev/null +++ b/foundry/v2/connectivity/models/_create_table_import_request_oracle_import_config_dict.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +import pydantic +from typing_extensions import TypedDict + + +class CreateTableImportRequestOracleImportConfigDict(TypedDict): + """CreateTableImportRequestOracleImportConfig""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + query: pydantic.StrictStr + """ + A single SQL query can be executed per sync, which should output a data table + and avoid operations like invoking stored procedures. + The query results are saved to the output dataset in Foundry. + """ + + type: Literal["oracleImportConfig"] diff --git a/foundry/v2/connectivity/models/_create_table_import_request_postgre_sql_import_config_dict.py b/foundry/v2/connectivity/models/_create_table_import_request_postgre_sql_import_config_dict.py new file mode 100644 index 00000000..d9f5db2c --- /dev/null +++ b/foundry/v2/connectivity/models/_create_table_import_request_postgre_sql_import_config_dict.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +import pydantic +from typing_extensions import TypedDict + + +class CreateTableImportRequestPostgreSqlImportConfigDict(TypedDict): + """CreateTableImportRequestPostgreSqlImportConfig""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + query: pydantic.StrictStr + """ + A single SQL query can be executed per sync, which should output a data table + and avoid operations like invoking stored procedures. + The query results are saved to the output dataset in Foundry. + """ + + type: Literal["postgreSqlImportConfig"] diff --git a/foundry/v2/connectivity/models/_create_table_import_request_table_import_config_dict.py b/foundry/v2/connectivity/models/_create_table_import_request_table_import_config_dict.py new file mode 100644 index 00000000..f8b3bc08 --- /dev/null +++ b/foundry/v2/connectivity/models/_create_table_import_request_table_import_config_dict.py @@ -0,0 +1,49 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +import pydantic +from typing_extensions import Annotated + +from foundry.v2.connectivity.models._create_table_import_request_jdbc_import_config_dict import ( + CreateTableImportRequestJdbcImportConfigDict, +) # NOQA +from foundry.v2.connectivity.models._create_table_import_request_microsoft_access_import_config_dict import ( + CreateTableImportRequestMicrosoftAccessImportConfigDict, +) # NOQA +from foundry.v2.connectivity.models._create_table_import_request_microsoft_sql_server_import_config_dict import ( + CreateTableImportRequestMicrosoftSqlServerImportConfigDict, +) # NOQA +from foundry.v2.connectivity.models._create_table_import_request_oracle_import_config_dict import ( + CreateTableImportRequestOracleImportConfigDict, +) # NOQA +from foundry.v2.connectivity.models._create_table_import_request_postgre_sql_import_config_dict import ( + CreateTableImportRequestPostgreSqlImportConfigDict, +) # NOQA + +CreateTableImportRequestTableImportConfigDict = Annotated[ + Union[ + CreateTableImportRequestJdbcImportConfigDict, + CreateTableImportRequestMicrosoftSqlServerImportConfigDict, + CreateTableImportRequestPostgreSqlImportConfigDict, + CreateTableImportRequestMicrosoftAccessImportConfigDict, + CreateTableImportRequestOracleImportConfigDict, + ], + pydantic.Field(discriminator="type"), +] +"""The import configuration for a specific [connector type](docs/foundry/data-integration/source-type-overview).""" diff --git a/foundry/v2/connectivity/models/_jdbc_import_config.py b/foundry/v2/connectivity/models/_jdbc_import_config.py new file mode 100644 index 00000000..7b0bf5a1 --- /dev/null +++ b/foundry/v2/connectivity/models/_jdbc_import_config.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +import pydantic + +from foundry.v2.connectivity.models._jdbc_import_config_dict import JdbcImportConfigDict + + +class JdbcImportConfig(pydantic.BaseModel): + """The import configuration for a [custom JDBC connection](docs/foundry/available-connectors/custom-jdbc-sources).""" + + query: pydantic.StrictStr + """ + A single SQL query can be executed per sync, which should output a data table + and avoid operations like invoking stored procedures. + The query results are saved to the output dataset in Foundry. + """ + + type: Literal["jdbcImportConfig"] = "jdbcImportConfig" + + model_config = {"extra": "allow"} + + def to_dict(self) -> JdbcImportConfigDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(JdbcImportConfigDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/connectivity/models/_jdbc_import_config_dict.py b/foundry/v2/connectivity/models/_jdbc_import_config_dict.py new file mode 100644 index 00000000..8c6b8f88 --- /dev/null +++ b/foundry/v2/connectivity/models/_jdbc_import_config_dict.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +import pydantic +from typing_extensions import TypedDict + + +class JdbcImportConfigDict(TypedDict): + """The import configuration for a [custom JDBC connection](docs/foundry/available-connectors/custom-jdbc-sources).""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + query: pydantic.StrictStr + """ + A single SQL query can be executed per sync, which should output a data table + and avoid operations like invoking stored procedures. + The query results are saved to the output dataset in Foundry. + """ + + type: Literal["jdbcImportConfig"] diff --git a/foundry/v2/connectivity/models/_microsoft_access_import_config.py b/foundry/v2/connectivity/models/_microsoft_access_import_config.py new file mode 100644 index 00000000..43195fd6 --- /dev/null +++ b/foundry/v2/connectivity/models/_microsoft_access_import_config.py @@ -0,0 +1,46 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +import pydantic + +from foundry.v2.connectivity.models._microsoft_access_import_config_dict import ( + MicrosoftAccessImportConfigDict, +) # NOQA + + +class MicrosoftAccessImportConfig(pydantic.BaseModel): + """The import configuration for a [Microsoft Access connection](docs/foundry/available-connectors/microsoft-access).""" + + query: pydantic.StrictStr + """ + A single SQL query can be executed per sync, which should output a data table + and avoid operations like invoking stored procedures. + The query results are saved to the output dataset in Foundry. + """ + + type: Literal["microsoftAccessImportConfig"] = "microsoftAccessImportConfig" + + model_config = {"extra": "allow"} + + def to_dict(self) -> MicrosoftAccessImportConfigDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + MicrosoftAccessImportConfigDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/connectivity/models/_microsoft_access_import_config_dict.py b/foundry/v2/connectivity/models/_microsoft_access_import_config_dict.py new file mode 100644 index 00000000..a4c614af --- /dev/null +++ b/foundry/v2/connectivity/models/_microsoft_access_import_config_dict.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +import pydantic +from typing_extensions import TypedDict + + +class MicrosoftAccessImportConfigDict(TypedDict): + """The import configuration for a [Microsoft Access connection](docs/foundry/available-connectors/microsoft-access).""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + query: pydantic.StrictStr + """ + A single SQL query can be executed per sync, which should output a data table + and avoid operations like invoking stored procedures. + The query results are saved to the output dataset in Foundry. + """ + + type: Literal["microsoftAccessImportConfig"] diff --git a/foundry/v2/connectivity/models/_microsoft_sql_server_import_config.py b/foundry/v2/connectivity/models/_microsoft_sql_server_import_config.py new file mode 100644 index 00000000..a0c9d4fd --- /dev/null +++ b/foundry/v2/connectivity/models/_microsoft_sql_server_import_config.py @@ -0,0 +1,46 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +import pydantic + +from foundry.v2.connectivity.models._microsoft_sql_server_import_config_dict import ( + MicrosoftSqlServerImportConfigDict, +) # NOQA + + +class MicrosoftSqlServerImportConfig(pydantic.BaseModel): + """The import configuration for a [Microsoft SQL Server connection](docs/foundry/available-connectors/microsoft-sql-server).""" + + query: pydantic.StrictStr + """ + A single SQL query can be executed per sync, which should output a data table + and avoid operations like invoking stored procedures. + The query results are saved to the output dataset in Foundry. + """ + + type: Literal["microsoftSqlServerImportConfig"] = "microsoftSqlServerImportConfig" + + model_config = {"extra": "allow"} + + def to_dict(self) -> MicrosoftSqlServerImportConfigDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + MicrosoftSqlServerImportConfigDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/connectivity/models/_microsoft_sql_server_import_config_dict.py b/foundry/v2/connectivity/models/_microsoft_sql_server_import_config_dict.py new file mode 100644 index 00000000..f335e490 --- /dev/null +++ b/foundry/v2/connectivity/models/_microsoft_sql_server_import_config_dict.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +import pydantic +from typing_extensions import TypedDict + + +class MicrosoftSqlServerImportConfigDict(TypedDict): + """The import configuration for a [Microsoft SQL Server connection](docs/foundry/available-connectors/microsoft-sql-server).""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + query: pydantic.StrictStr + """ + A single SQL query can be executed per sync, which should output a data table + and avoid operations like invoking stored procedures. + The query results are saved to the output dataset in Foundry. + """ + + type: Literal["microsoftSqlServerImportConfig"] diff --git a/foundry/v2/connectivity/models/_oidc.py b/foundry/v2/connectivity/models/_oidc.py new file mode 100644 index 00000000..74fd9190 --- /dev/null +++ b/foundry/v2/connectivity/models/_oidc.py @@ -0,0 +1,48 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +import pydantic + +from foundry.v2.connectivity.models._connection_rid import ConnectionRid +from foundry.v2.connectivity.models._oidc_dict import OidcDict + + +class Oidc(pydantic.BaseModel): + """ + [OpenID Connect (OIDC)](/docs/foundry/data-connection/oidc/) is an open authentication protocol that allows + you to authenticate to external system resources without the use of static credentials. + """ + + audience: pydantic.StrictStr + """The configured audience that identifies the external system.""" + + issuer_url: pydantic.StrictStr = pydantic.Field(alias="issuerUrl") + """The URL that identifies Foundry as an OIDC identity provider.""" + + subject: ConnectionRid + """The RID of the Connection that is connecting to the external system.""" + + type: Literal["oidc"] = "oidc" + + model_config = {"extra": "allow"} + + def to_dict(self) -> OidcDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OidcDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/connectivity/models/_oidc_dict.py b/foundry/v2/connectivity/models/_oidc_dict.py new file mode 100644 index 00000000..aede58f2 --- /dev/null +++ b/foundry/v2/connectivity/models/_oidc_dict.py @@ -0,0 +1,43 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +import pydantic +from typing_extensions import TypedDict + +from foundry.v2.connectivity.models._connection_rid import ConnectionRid + + +class OidcDict(TypedDict): + """ + [OpenID Connect (OIDC)](/docs/foundry/data-connection/oidc/) is an open authentication protocol that allows + you to authenticate to external system resources without the use of static credentials. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + audience: pydantic.StrictStr + """The configured audience that identifies the external system.""" + + issuerUrl: pydantic.StrictStr + """The URL that identifies Foundry as an OIDC identity provider.""" + + subject: ConnectionRid + """The RID of the Connection that is connecting to the external system.""" + + type: Literal["oidc"] diff --git a/foundry/v2/connectivity/models/_oracle_import_config.py b/foundry/v2/connectivity/models/_oracle_import_config.py new file mode 100644 index 00000000..2f5256b5 --- /dev/null +++ b/foundry/v2/connectivity/models/_oracle_import_config.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +import pydantic + +from foundry.v2.connectivity.models._oracle_import_config_dict import OracleImportConfigDict # NOQA + + +class OracleImportConfig(pydantic.BaseModel): + """The import configuration for an Oracle Database 21 connection.""" + + query: pydantic.StrictStr + """ + A single SQL query can be executed per sync, which should output a data table + and avoid operations like invoking stored procedures. + The query results are saved to the output dataset in Foundry. + """ + + type: Literal["oracleImportConfig"] = "oracleImportConfig" + + model_config = {"extra": "allow"} + + def to_dict(self) -> OracleImportConfigDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(OracleImportConfigDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/connectivity/models/_oracle_import_config_dict.py b/foundry/v2/connectivity/models/_oracle_import_config_dict.py new file mode 100644 index 00000000..171ded6a --- /dev/null +++ b/foundry/v2/connectivity/models/_oracle_import_config_dict.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +import pydantic +from typing_extensions import TypedDict + + +class OracleImportConfigDict(TypedDict): + """The import configuration for an Oracle Database 21 connection.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + query: pydantic.StrictStr + """ + A single SQL query can be executed per sync, which should output a data table + and avoid operations like invoking stored procedures. + The query results are saved to the output dataset in Foundry. + """ + + type: Literal["oracleImportConfig"] diff --git a/foundry/v2/connectivity/models/_postgre_sql_import_config.py b/foundry/v2/connectivity/models/_postgre_sql_import_config.py new file mode 100644 index 00000000..616d7fc7 --- /dev/null +++ b/foundry/v2/connectivity/models/_postgre_sql_import_config.py @@ -0,0 +1,44 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +import pydantic + +from foundry.v2.connectivity.models._postgre_sql_import_config_dict import ( + PostgreSqlImportConfigDict, +) # NOQA + + +class PostgreSqlImportConfig(pydantic.BaseModel): + """The import configuration for a [PostgreSQL connection](docs/foundry/available-connectors/postgresql).""" + + query: pydantic.StrictStr + """ + A single SQL query can be executed per sync, which should output a data table + and avoid operations like invoking stored procedures. + The query results are saved to the output dataset in Foundry. + """ + + type: Literal["postgreSqlImportConfig"] = "postgreSqlImportConfig" + + model_config = {"extra": "allow"} + + def to_dict(self) -> PostgreSqlImportConfigDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(PostgreSqlImportConfigDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/connectivity/models/_postgre_sql_import_config_dict.py b/foundry/v2/connectivity/models/_postgre_sql_import_config_dict.py new file mode 100644 index 00000000..7e8ce6b1 --- /dev/null +++ b/foundry/v2/connectivity/models/_postgre_sql_import_config_dict.py @@ -0,0 +1,36 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +import pydantic +from typing_extensions import TypedDict + + +class PostgreSqlImportConfigDict(TypedDict): + """The import configuration for a [PostgreSQL connection](docs/foundry/available-connectors/postgresql).""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + query: pydantic.StrictStr + """ + A single SQL query can be executed per sync, which should output a data table + and avoid operations like invoking stored procedures. + The query results are saved to the output dataset in Foundry. + """ + + type: Literal["postgreSqlImportConfig"] diff --git a/foundry/v2/connectivity/models/_s3_authentication_mode.py b/foundry/v2/connectivity/models/_s3_authentication_mode.py index bff06911..0fa76460 100644 --- a/foundry/v2/connectivity/models/_s3_authentication_mode.py +++ b/foundry/v2/connectivity/models/_s3_authentication_mode.py @@ -15,7 +15,16 @@ from __future__ import annotations +from typing import Union + +import pydantic +from typing_extensions import Annotated + from foundry.v2.connectivity.models._aws_access_key import AwsAccessKey +from foundry.v2.connectivity.models._cloud_identity import CloudIdentity +from foundry.v2.connectivity.models._oidc import Oidc -S3AuthenticationMode = AwsAccessKey +S3AuthenticationMode = Annotated[ + Union[AwsAccessKey, CloudIdentity, Oidc], pydantic.Field(discriminator="type") +] """S3AuthenticationMode""" diff --git a/foundry/v2/connectivity/models/_s3_authentication_mode_dict.py b/foundry/v2/connectivity/models/_s3_authentication_mode_dict.py index 12de6c30..23ed825e 100644 --- a/foundry/v2/connectivity/models/_s3_authentication_mode_dict.py +++ b/foundry/v2/connectivity/models/_s3_authentication_mode_dict.py @@ -15,7 +15,16 @@ from __future__ import annotations +from typing import Union + +import pydantic +from typing_extensions import Annotated + from foundry.v2.connectivity.models._aws_access_key_dict import AwsAccessKeyDict +from foundry.v2.connectivity.models._cloud_identity_dict import CloudIdentityDict +from foundry.v2.connectivity.models._oidc_dict import OidcDict -S3AuthenticationModeDict = AwsAccessKeyDict +S3AuthenticationModeDict = Annotated[ + Union[AwsAccessKeyDict, CloudIdentityDict, OidcDict], pydantic.Field(discriminator="type") +] """S3AuthenticationMode""" diff --git a/foundry/v2/connectivity/models/_table_import.py b/foundry/v2/connectivity/models/_table_import.py new file mode 100644 index 00000000..081a812d --- /dev/null +++ b/foundry/v2/connectivity/models/_table_import.py @@ -0,0 +1,57 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Optional +from typing import cast + +import pydantic + +from foundry.v2.connectivity.models._connection_rid import ConnectionRid +from foundry.v2.connectivity.models._table_import_config import TableImportConfig +from foundry.v2.connectivity.models._table_import_dict import TableImportDict +from foundry.v2.connectivity.models._table_import_display_name import TableImportDisplayName # NOQA +from foundry.v2.connectivity.models._table_import_mode import TableImportMode +from foundry.v2.connectivity.models._table_import_rid import TableImportRid +from foundry.v2.datasets.models._branch_name import BranchName +from foundry.v2.datasets.models._dataset_rid import DatasetRid + + +class TableImport(pydantic.BaseModel): + """TableImport""" + + rid: TableImportRid + + connection_rid: ConnectionRid = pydantic.Field(alias="connectionRid") + """The RID of the Connection (formerly known as a source) that the Table Import uses to import data.""" + + dataset_rid: DatasetRid = pydantic.Field(alias="datasetRid") + """The RID of the output dataset.""" + + branch_name: Optional[BranchName] = pydantic.Field(alias="branchName", default=None) + """The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments.""" + + display_name: TableImportDisplayName = pydantic.Field(alias="displayName") + + import_mode: TableImportMode = pydantic.Field(alias="importMode") + + config: TableImportConfig + + model_config = {"extra": "allow"} + + def to_dict(self) -> TableImportDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast(TableImportDict, self.model_dump(by_alias=True, exclude_unset=True)) diff --git a/foundry/v2/connectivity/models/_table_import_config.py b/foundry/v2/connectivity/models/_table_import_config.py new file mode 100644 index 00000000..fcd42a61 --- /dev/null +++ b/foundry/v2/connectivity/models/_table_import_config.py @@ -0,0 +1,43 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +import pydantic +from typing_extensions import Annotated + +from foundry.v2.connectivity.models._jdbc_import_config import JdbcImportConfig +from foundry.v2.connectivity.models._microsoft_access_import_config import ( + MicrosoftAccessImportConfig, +) # NOQA +from foundry.v2.connectivity.models._microsoft_sql_server_import_config import ( + MicrosoftSqlServerImportConfig, +) # NOQA +from foundry.v2.connectivity.models._oracle_import_config import OracleImportConfig +from foundry.v2.connectivity.models._postgre_sql_import_config import PostgreSqlImportConfig # NOQA + +TableImportConfig = Annotated[ + Union[ + JdbcImportConfig, + MicrosoftSqlServerImportConfig, + PostgreSqlImportConfig, + MicrosoftAccessImportConfig, + OracleImportConfig, + ], + pydantic.Field(discriminator="type"), +] +"""The import configuration for a specific [connector type](docs/foundry/data-integration/source-type-overview).""" diff --git a/foundry/v2/connectivity/models/_table_import_config_dict.py b/foundry/v2/connectivity/models/_table_import_config_dict.py new file mode 100644 index 00000000..b30dcb1b --- /dev/null +++ b/foundry/v2/connectivity/models/_table_import_config_dict.py @@ -0,0 +1,45 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +import pydantic +from typing_extensions import Annotated + +from foundry.v2.connectivity.models._jdbc_import_config_dict import JdbcImportConfigDict +from foundry.v2.connectivity.models._microsoft_access_import_config_dict import ( + MicrosoftAccessImportConfigDict, +) # NOQA +from foundry.v2.connectivity.models._microsoft_sql_server_import_config_dict import ( + MicrosoftSqlServerImportConfigDict, +) # NOQA +from foundry.v2.connectivity.models._oracle_import_config_dict import OracleImportConfigDict # NOQA +from foundry.v2.connectivity.models._postgre_sql_import_config_dict import ( + PostgreSqlImportConfigDict, +) # NOQA + +TableImportConfigDict = Annotated[ + Union[ + JdbcImportConfigDict, + MicrosoftSqlServerImportConfigDict, + PostgreSqlImportConfigDict, + MicrosoftAccessImportConfigDict, + OracleImportConfigDict, + ], + pydantic.Field(discriminator="type"), +] +"""The import configuration for a specific [connector type](docs/foundry/data-integration/source-type-overview).""" diff --git a/foundry/v2/connectivity/models/_table_import_dict.py b/foundry/v2/connectivity/models/_table_import_dict.py new file mode 100644 index 00000000..2e738b41 --- /dev/null +++ b/foundry/v2/connectivity/models/_table_import_dict.py @@ -0,0 +1,50 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.connectivity.models._connection_rid import ConnectionRid +from foundry.v2.connectivity.models._table_import_config_dict import TableImportConfigDict # NOQA +from foundry.v2.connectivity.models._table_import_display_name import TableImportDisplayName # NOQA +from foundry.v2.connectivity.models._table_import_mode import TableImportMode +from foundry.v2.connectivity.models._table_import_rid import TableImportRid +from foundry.v2.datasets.models._branch_name import BranchName +from foundry.v2.datasets.models._dataset_rid import DatasetRid + + +class TableImportDict(TypedDict): + """TableImport""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + rid: TableImportRid + + connectionRid: ConnectionRid + """The RID of the Connection (formerly known as a source) that the Table Import uses to import data.""" + + datasetRid: DatasetRid + """The RID of the output dataset.""" + + branchName: NotRequired[BranchName] + """The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments.""" + + displayName: TableImportDisplayName + + importMode: TableImportMode + + config: TableImportConfigDict diff --git a/foundry/v2/connectivity/models/_table_import_display_name.py b/foundry/v2/connectivity/models/_table_import_display_name.py new file mode 100644 index 00000000..42fccb88 --- /dev/null +++ b/foundry/v2/connectivity/models/_table_import_display_name.py @@ -0,0 +1,21 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +import pydantic + +TableImportDisplayName = pydantic.StrictStr +"""TableImportDisplayName""" diff --git a/foundry/v2/connectivity/models/_table_import_mode.py b/foundry/v2/connectivity/models/_table_import_mode.py new file mode 100644 index 00000000..8c8058b0 --- /dev/null +++ b/foundry/v2/connectivity/models/_table_import_mode.py @@ -0,0 +1,26 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +TableImportMode = Literal["SNAPSHOT", "APPEND"] +""" +Import mode governs how data is read from an external system, and written into a Foundry dataset. + +SNAPSHOT: Defines a new dataset state consisting only of data from a particular import execution. +APPEND: Purely additive and yields data from previous import executions in addition to newly added data. +""" diff --git a/foundry/v2/connectivity/models/_table_import_rid.py b/foundry/v2/connectivity/models/_table_import_rid.py new file mode 100644 index 00000000..af7c965d --- /dev/null +++ b/foundry/v2/connectivity/models/_table_import_rid.py @@ -0,0 +1,21 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from foundry._core.utils import RID + +TableImportRid = RID +"""The Resource Identifier (RID) of a TableImport (formerly known as a batch sync).""" diff --git a/foundry/v2/connectivity/table_import.py b/foundry/v2/connectivity/table_import.py new file mode 100644 index 00000000..06bc28da --- /dev/null +++ b/foundry/v2/connectivity/table_import.py @@ -0,0 +1,256 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Any +from typing import Dict +from typing import Optional + +import pydantic +from typing_extensions import Annotated +from typing_extensions import TypedDict + +from foundry._core import ApiClient +from foundry._core import Auth +from foundry._core import RequestInfo +from foundry._errors import handle_unexpected +from foundry.v2.connectivity.models._connection_rid import ConnectionRid +from foundry.v2.connectivity.models._create_table_import_request_table_import_config_dict import ( + CreateTableImportRequestTableImportConfigDict, +) # NOQA +from foundry.v2.connectivity.models._table_import import TableImport +from foundry.v2.connectivity.models._table_import_display_name import TableImportDisplayName # NOQA +from foundry.v2.connectivity.models._table_import_mode import TableImportMode +from foundry.v2.connectivity.models._table_import_rid import TableImportRid +from foundry.v2.core.models._preview_mode import PreviewMode +from foundry.v2.datasets.models._branch_name import BranchName +from foundry.v2.datasets.models._dataset_rid import DatasetRid +from foundry.v2.orchestration.models._build_rid import BuildRid + + +class TableImportClient: + def __init__(self, auth: Auth, hostname: str) -> None: + self._api_client = ApiClient(auth=auth, hostname=hostname) + + @pydantic.validate_call + @handle_unexpected + def create( + self, + connection_rid: ConnectionRid, + *, + config: CreateTableImportRequestTableImportConfigDict, + dataset_rid: DatasetRid, + display_name: TableImportDisplayName, + import_mode: TableImportMode, + branch_name: Optional[BranchName] = None, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[pydantic.StrictInt, pydantic.Field(gt=0)]] = None, + ) -> TableImport: + """ + Creates a new TableImport. + :param connection_rid: connectionRid + :type connection_rid: ConnectionRid + :param config: + :type config: CreateTableImportRequestTableImportConfigDict + :param dataset_rid: The RID of the output dataset. + :type dataset_rid: DatasetRid + :param display_name: + :type display_name: TableImportDisplayName + :param import_mode: + :type import_mode: TableImportMode + :param branch_name: The branch name in the output dataset that will contain the imported data. Defaults to `master` for most enrollments. + :type branch_name: Optional[BranchName] + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: TableImport + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/connectivity/connections/{connectionRid}/tableImports", + query_params={ + "preview": preview, + }, + path_params={ + "connectionRid": connection_rid, + }, + header_params={ + "Content-Type": "application/json", + "Accept": "application/json", + }, + body={ + "datasetRid": dataset_rid, + "importMode": import_mode, + "displayName": display_name, + "branchName": branch_name, + "config": config, + }, + body_type=TypedDict( + "Body", + { # type: ignore + "datasetRid": DatasetRid, + "importMode": TableImportMode, + "displayName": TableImportDisplayName, + "branchName": Optional[BranchName], + "config": CreateTableImportRequestTableImportConfigDict, + }, + ), + response_type=TableImport, + request_timeout=request_timeout, + ), + ) + + @pydantic.validate_call + @handle_unexpected + def delete( + self, + connection_rid: ConnectionRid, + table_import_rid: TableImportRid, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[pydantic.StrictInt, pydantic.Field(gt=0)]] = None, + ) -> None: + """ + Delete the TableImport with the specified RID. + Deleting the table import does not delete the destination dataset but the dataset will no longer + be updated by this import. + + :param connection_rid: connectionRid + :type connection_rid: ConnectionRid + :param table_import_rid: tableImportRid + :type table_import_rid: TableImportRid + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: None + """ + + return self._api_client.call_api( + RequestInfo( + method="DELETE", + resource_path="/v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid}", + query_params={ + "preview": preview, + }, + path_params={ + "connectionRid": connection_rid, + "tableImportRid": table_import_rid, + }, + header_params={}, + body=None, + body_type=None, + response_type=None, + request_timeout=request_timeout, + ), + ) + + @pydantic.validate_call + @handle_unexpected + def execute( + self, + connection_rid: ConnectionRid, + table_import_rid: TableImportRid, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[pydantic.StrictInt, pydantic.Field(gt=0)]] = None, + ) -> BuildRid: + """ + Executes the TableImport, which runs asynchronously as a [Foundry Build](/docs/foundry/data-integration/builds/). + The returned BuildRid can be used to check the status via the Orchestration API. + + :param connection_rid: connectionRid + :type connection_rid: ConnectionRid + :param table_import_rid: tableImportRid + :type table_import_rid: TableImportRid + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: BuildRid + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid}/execute", + query_params={ + "preview": preview, + }, + path_params={ + "connectionRid": connection_rid, + "tableImportRid": table_import_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=BuildRid, + request_timeout=request_timeout, + ), + ) + + @pydantic.validate_call + @handle_unexpected + def get( + self, + connection_rid: ConnectionRid, + table_import_rid: TableImportRid, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[pydantic.StrictInt, pydantic.Field(gt=0)]] = None, + ) -> TableImport: + """ + Get the TableImport with the specified rid. + :param connection_rid: connectionRid + :type connection_rid: ConnectionRid + :param table_import_rid: tableImportRid + :type table_import_rid: TableImportRid + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: TableImport + """ + + return self._api_client.call_api( + RequestInfo( + method="GET", + resource_path="/v2/connectivity/connections/{connectionRid}/tableImports/{tableImportRid}", + query_params={ + "preview": preview, + }, + path_params={ + "connectionRid": connection_rid, + "tableImportRid": table_import_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=TableImport, + request_timeout=request_timeout, + ), + ) diff --git a/foundry/v2/core/models/_file_path.py b/foundry/v2/core/models/_file_path.py index fe079964..a230b25d 100644 --- a/foundry/v2/core/models/_file_path.py +++ b/foundry/v2/core/models/_file_path.py @@ -18,4 +18,4 @@ import pydantic FilePath = pydantic.StrictStr -"""The path to a File within Foundry. Examples: `my-file.txt`, `path/to/my-file.jpg`, `dataframe.snappy.parquet`.""" +"""The path to a File within Foundry.""" diff --git a/foundry/v2/core/models/_timeseries_type.py b/foundry/v2/core/models/_timeseries_type.py index 33907a55..40789645 100644 --- a/foundry/v2/core/models/_timeseries_type.py +++ b/foundry/v2/core/models/_timeseries_type.py @@ -16,6 +16,7 @@ from __future__ import annotations from typing import Literal +from typing import Optional from typing import cast import pydantic @@ -27,7 +28,7 @@ class TimeseriesType(pydantic.BaseModel): """TimeseriesType""" - item_type: TimeSeriesItemType = pydantic.Field(alias="itemType") + item_type: Optional[TimeSeriesItemType] = pydantic.Field(alias="itemType", default=None) type: Literal["timeseries"] = "timeseries" diff --git a/foundry/v2/core/models/_timeseries_type_dict.py b/foundry/v2/core/models/_timeseries_type_dict.py index d2d48240..cda8f70e 100644 --- a/foundry/v2/core/models/_timeseries_type_dict.py +++ b/foundry/v2/core/models/_timeseries_type_dict.py @@ -17,6 +17,7 @@ from typing import Literal +from typing_extensions import NotRequired from typing_extensions import TypedDict from foundry.v2.core.models._time_series_item_type_dict import TimeSeriesItemTypeDict @@ -27,6 +28,6 @@ class TimeseriesTypeDict(TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore - itemType: TimeSeriesItemTypeDict + itemType: NotRequired[TimeSeriesItemTypeDict] type: Literal["timeseries"] diff --git a/foundry/v2/datasets/dataset.py b/foundry/v2/datasets/dataset.py index f43fc3a3..d92a83d6 100644 --- a/foundry/v2/datasets/dataset.py +++ b/foundry/v2/datasets/dataset.py @@ -149,7 +149,7 @@ def read_table( """ Gets the content of a dataset as a table in the specified format. - This endpoint currently does not support views (Virtual datasets composed of other datasets). + This endpoint currently does not support views (virtual datasets composed of other datasets). :param dataset_rid: datasetRid :type dataset_rid: DatasetRid diff --git a/foundry/v2/mediasets/models/__init__.py b/foundry/v2/mediasets/models/__init__.py new file mode 100644 index 00000000..6dd5770f --- /dev/null +++ b/foundry/v2/mediasets/models/__init__.py @@ -0,0 +1,16 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +__all__ = [] diff --git a/foundry/v2/ontologies/models/_action_parameter_type.py b/foundry/v2/ontologies/models/_action_parameter_type.py index b0134614..056fd1de 100644 --- a/foundry/v2/ontologies/models/_action_parameter_type.py +++ b/foundry/v2/ontologies/models/_action_parameter_type.py @@ -34,8 +34,14 @@ from foundry.v2.ontologies.models._action_parameter_array_type_dict import ( ActionParameterArrayTypeDict, ) # NOQA +from foundry.v2.ontologies.models._ontology_interface_object_type import ( + OntologyInterfaceObjectType, +) # NOQA from foundry.v2.ontologies.models._ontology_object_set_type import OntologyObjectSetType from foundry.v2.ontologies.models._ontology_object_type import OntologyObjectType +from foundry.v2.ontologies.models._ontology_object_type_reference_type import ( + OntologyObjectTypeReferenceType, +) # NOQA class ActionParameterArrayType(pydantic.BaseModel): @@ -57,15 +63,17 @@ def to_dict(self) -> ActionParameterArrayTypeDict: ActionParameterType = Annotated[ Union[ DateType, + OntologyInterfaceObjectType, + StringType, + DoubleType, + IntegerType, + LongType, + OntologyObjectTypeReferenceType, BooleanType, MarkingType, AttachmentType, - StringType, ActionParameterArrayType, OntologyObjectSetType, - DoubleType, - IntegerType, - LongType, OntologyObjectType, TimestampType, ], diff --git a/foundry/v2/ontologies/models/_action_parameter_type_dict.py b/foundry/v2/ontologies/models/_action_parameter_type_dict.py index fb98810c..b04bfdd9 100644 --- a/foundry/v2/ontologies/models/_action_parameter_type_dict.py +++ b/foundry/v2/ontologies/models/_action_parameter_type_dict.py @@ -31,10 +31,16 @@ from foundry.v2.core.models._marking_type_dict import MarkingTypeDict from foundry.v2.core.models._string_type_dict import StringTypeDict from foundry.v2.core.models._timestamp_type_dict import TimestampTypeDict +from foundry.v2.ontologies.models._ontology_interface_object_type_dict import ( + OntologyInterfaceObjectTypeDict, +) # NOQA from foundry.v2.ontologies.models._ontology_object_set_type_dict import ( OntologyObjectSetTypeDict, ) # NOQA from foundry.v2.ontologies.models._ontology_object_type_dict import OntologyObjectTypeDict # NOQA +from foundry.v2.ontologies.models._ontology_object_type_reference_type_dict import ( + OntologyObjectTypeReferenceTypeDict, +) # NOQA class ActionParameterArrayTypeDict(TypedDict): @@ -50,15 +56,17 @@ class ActionParameterArrayTypeDict(TypedDict): ActionParameterTypeDict = Annotated[ Union[ DateTypeDict, + OntologyInterfaceObjectTypeDict, + StringTypeDict, + DoubleTypeDict, + IntegerTypeDict, + LongTypeDict, + OntologyObjectTypeReferenceTypeDict, BooleanTypeDict, MarkingTypeDict, AttachmentTypeDict, - StringTypeDict, ActionParameterArrayTypeDict, OntologyObjectSetTypeDict, - DoubleTypeDict, - IntegerTypeDict, - LongTypeDict, OntologyObjectTypeDict, TimestampTypeDict, ], diff --git a/foundry/v2/ontologies/models/_active_property_type_status.py b/foundry/v2/ontologies/models/_active_property_type_status.py new file mode 100644 index 00000000..fc356a2c --- /dev/null +++ b/foundry/v2/ontologies/models/_active_property_type_status.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +import pydantic + +from foundry.v2.ontologies.models._active_property_type_status_dict import ( + ActivePropertyTypeStatusDict, +) # NOQA + + +class ActivePropertyTypeStatus(pydantic.BaseModel): + """ + This status indicates that the PropertyType will not change on short notice and should thus be safe to use in + user facing workflows. + """ + + type: Literal["active"] = "active" + + model_config = {"extra": "allow"} + + def to_dict(self) -> ActivePropertyTypeStatusDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ActivePropertyTypeStatusDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_active_property_type_status_dict.py b/foundry/v2/ontologies/models/_active_property_type_status_dict.py new file mode 100644 index 00000000..58cab718 --- /dev/null +++ b/foundry/v2/ontologies/models/_active_property_type_status_dict.py @@ -0,0 +1,31 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + + +class ActivePropertyTypeStatusDict(TypedDict): + """ + This status indicates that the PropertyType will not change on short notice and should thus be safe to use in + user facing workflows. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + type: Literal["active"] diff --git a/foundry/v2/ontologies/models/_create_interface_object_rule.py b/foundry/v2/ontologies/models/_create_interface_object_rule.py index 5757f566..8996f328 100644 --- a/foundry/v2/ontologies/models/_create_interface_object_rule.py +++ b/foundry/v2/ontologies/models/_create_interface_object_rule.py @@ -23,11 +23,14 @@ from foundry.v2.ontologies.models._create_interface_object_rule_dict import ( CreateInterfaceObjectRuleDict, ) # NOQA +from foundry.v2.ontologies.models._interface_type_api_name import InterfaceTypeApiName class CreateInterfaceObjectRule(pydantic.BaseModel): """CreateInterfaceObjectRule""" + interface_type_api_name: InterfaceTypeApiName = pydantic.Field(alias="interfaceTypeApiName") + type: Literal["createInterfaceObject"] = "createInterfaceObject" model_config = {"extra": "allow"} diff --git a/foundry/v2/ontologies/models/_create_interface_object_rule_dict.py b/foundry/v2/ontologies/models/_create_interface_object_rule_dict.py index 37803055..09ac9473 100644 --- a/foundry/v2/ontologies/models/_create_interface_object_rule_dict.py +++ b/foundry/v2/ontologies/models/_create_interface_object_rule_dict.py @@ -19,10 +19,14 @@ from typing_extensions import TypedDict +from foundry.v2.ontologies.models._interface_type_api_name import InterfaceTypeApiName + class CreateInterfaceObjectRuleDict(TypedDict): """CreateInterfaceObjectRule""" __pydantic_config__ = {"extra": "allow"} # type: ignore + interfaceTypeApiName: InterfaceTypeApiName + type: Literal["createInterfaceObject"] diff --git a/foundry/v2/ontologies/models/_delete_interface_object_rule.py b/foundry/v2/ontologies/models/_delete_interface_object_rule.py new file mode 100644 index 00000000..83e1923c --- /dev/null +++ b/foundry/v2/ontologies/models/_delete_interface_object_rule.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +import pydantic + +from foundry.v2.ontologies.models._delete_interface_object_rule_dict import ( + DeleteInterfaceObjectRuleDict, +) # NOQA +from foundry.v2.ontologies.models._interface_type_api_name import InterfaceTypeApiName + + +class DeleteInterfaceObjectRule(pydantic.BaseModel): + """DeleteInterfaceObjectRule""" + + interface_type_api_name: InterfaceTypeApiName = pydantic.Field(alias="interfaceTypeApiName") + + type: Literal["deleteInterfaceObject"] = "deleteInterfaceObject" + + model_config = {"extra": "allow"} + + def to_dict(self) -> DeleteInterfaceObjectRuleDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + DeleteInterfaceObjectRuleDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_delete_interface_object_rule_dict.py b/foundry/v2/ontologies/models/_delete_interface_object_rule_dict.py new file mode 100644 index 00000000..8d511292 --- /dev/null +++ b/foundry/v2/ontologies/models/_delete_interface_object_rule_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._interface_type_api_name import InterfaceTypeApiName + + +class DeleteInterfaceObjectRuleDict(TypedDict): + """DeleteInterfaceObjectRule""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + interfaceTypeApiName: InterfaceTypeApiName + + type: Literal["deleteInterfaceObject"] diff --git a/foundry/v2/ontologies/models/_deprecated_property_type_status.py b/foundry/v2/ontologies/models/_deprecated_property_type_status.py new file mode 100644 index 00000000..14030134 --- /dev/null +++ b/foundry/v2/ontologies/models/_deprecated_property_type_status.py @@ -0,0 +1,51 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from datetime import datetime +from typing import Literal +from typing import Optional +from typing import cast + +import pydantic + +from foundry.v2.ontologies.models._deprecated_property_type_status_dict import ( + DeprecatedPropertyTypeStatusDict, +) # NOQA +from foundry.v2.ontologies.models._property_type_rid import PropertyTypeRid + + +class DeprecatedPropertyTypeStatus(pydantic.BaseModel): + """ + This status indicates that the PropertyType is reaching the end of its life and will be removed as per the + deadline specified. + """ + + message: pydantic.StrictStr + + deadline: datetime + + replaced_by: Optional[PropertyTypeRid] = pydantic.Field(alias="replacedBy", default=None) + + type: Literal["deprecated"] = "deprecated" + + model_config = {"extra": "allow"} + + def to_dict(self) -> DeprecatedPropertyTypeStatusDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + DeprecatedPropertyTypeStatusDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_deprecated_property_type_status_dict.py b/foundry/v2/ontologies/models/_deprecated_property_type_status_dict.py new file mode 100644 index 00000000..b8b22734 --- /dev/null +++ b/foundry/v2/ontologies/models/_deprecated_property_type_status_dict.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from datetime import datetime +from typing import Literal + +import pydantic +from typing_extensions import NotRequired +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._property_type_rid import PropertyTypeRid + + +class DeprecatedPropertyTypeStatusDict(TypedDict): + """ + This status indicates that the PropertyType is reaching the end of its life and will be removed as per the + deadline specified. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + message: pydantic.StrictStr + + deadline: datetime + + replacedBy: NotRequired[PropertyTypeRid] + + type: Literal["deprecated"] diff --git a/foundry/v2/ontologies/models/_example_property_type_status.py b/foundry/v2/ontologies/models/_example_property_type_status.py new file mode 100644 index 00000000..6643a892 --- /dev/null +++ b/foundry/v2/ontologies/models/_example_property_type_status.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +import pydantic + +from foundry.v2.ontologies.models._example_property_type_status_dict import ( + ExamplePropertyTypeStatusDict, +) # NOQA + + +class ExamplePropertyTypeStatus(pydantic.BaseModel): + """ + This status indicates that the PropertyType is an example. It is backed by notional data that should not be + used for actual workflows, but can be used to test those workflows. + """ + + type: Literal["example"] = "example" + + model_config = {"extra": "allow"} + + def to_dict(self) -> ExamplePropertyTypeStatusDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ExamplePropertyTypeStatusDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_example_property_type_status_dict.py b/foundry/v2/ontologies/models/_example_property_type_status_dict.py new file mode 100644 index 00000000..8def3053 --- /dev/null +++ b/foundry/v2/ontologies/models/_example_property_type_status_dict.py @@ -0,0 +1,31 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + + +class ExamplePropertyTypeStatusDict(TypedDict): + """ + This status indicates that the PropertyType is an example. It is backed by notional data that should not be + used for actual workflows, but can be used to test those workflows. + """ + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + type: Literal["example"] diff --git a/foundry/v2/ontologies/models/_experimental_property_type_status.py b/foundry/v2/ontologies/models/_experimental_property_type_status.py new file mode 100644 index 00000000..a1b7d018 --- /dev/null +++ b/foundry/v2/ontologies/models/_experimental_property_type_status.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +import pydantic + +from foundry.v2.ontologies.models._experimental_property_type_status_dict import ( + ExperimentalPropertyTypeStatusDict, +) # NOQA + + +class ExperimentalPropertyTypeStatus(pydantic.BaseModel): + """This status indicates that the PropertyType is in development.""" + + type: Literal["experimental"] = "experimental" + + model_config = {"extra": "allow"} + + def to_dict(self) -> ExperimentalPropertyTypeStatusDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + ExperimentalPropertyTypeStatusDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_experimental_property_type_status_dict.py b/foundry/v2/ontologies/models/_experimental_property_type_status_dict.py new file mode 100644 index 00000000..cc89cff3 --- /dev/null +++ b/foundry/v2/ontologies/models/_experimental_property_type_status_dict.py @@ -0,0 +1,28 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + + +class ExperimentalPropertyTypeStatusDict(TypedDict): + """This status indicates that the PropertyType is in development.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + type: Literal["experimental"] diff --git a/foundry/v2/ontologies/models/_logic_rule.py b/foundry/v2/ontologies/models/_logic_rule.py index 522c895e..8cd874b9 100644 --- a/foundry/v2/ontologies/models/_logic_rule.py +++ b/foundry/v2/ontologies/models/_logic_rule.py @@ -25,6 +25,9 @@ ) # NOQA from foundry.v2.ontologies.models._create_link_rule import CreateLinkRule from foundry.v2.ontologies.models._create_object_rule import CreateObjectRule +from foundry.v2.ontologies.models._delete_interface_object_rule import ( + DeleteInterfaceObjectRule, +) # NOQA from foundry.v2.ontologies.models._delete_link_rule import DeleteLinkRule from foundry.v2.ontologies.models._delete_object_rule import DeleteObjectRule from foundry.v2.ontologies.models._modify_interface_object_rule import ( @@ -34,6 +37,7 @@ LogicRule = Annotated[ Union[ + DeleteInterfaceObjectRule, ModifyInterfaceObjectRule, ModifyObjectRule, DeleteObjectRule, diff --git a/foundry/v2/ontologies/models/_logic_rule_dict.py b/foundry/v2/ontologies/models/_logic_rule_dict.py index ceb8395b..5fe507a8 100644 --- a/foundry/v2/ontologies/models/_logic_rule_dict.py +++ b/foundry/v2/ontologies/models/_logic_rule_dict.py @@ -25,6 +25,9 @@ ) # NOQA from foundry.v2.ontologies.models._create_link_rule_dict import CreateLinkRuleDict from foundry.v2.ontologies.models._create_object_rule_dict import CreateObjectRuleDict +from foundry.v2.ontologies.models._delete_interface_object_rule_dict import ( + DeleteInterfaceObjectRuleDict, +) # NOQA from foundry.v2.ontologies.models._delete_link_rule_dict import DeleteLinkRuleDict from foundry.v2.ontologies.models._delete_object_rule_dict import DeleteObjectRuleDict from foundry.v2.ontologies.models._modify_interface_object_rule_dict import ( @@ -34,6 +37,7 @@ LogicRuleDict = Annotated[ Union[ + DeleteInterfaceObjectRuleDict, ModifyInterfaceObjectRuleDict, ModifyObjectRuleDict, DeleteObjectRuleDict, diff --git a/foundry/v2/ontologies/models/_modify_interface_object_rule.py b/foundry/v2/ontologies/models/_modify_interface_object_rule.py index 17038969..9f5ccb0e 100644 --- a/foundry/v2/ontologies/models/_modify_interface_object_rule.py +++ b/foundry/v2/ontologies/models/_modify_interface_object_rule.py @@ -20,6 +20,7 @@ import pydantic +from foundry.v2.ontologies.models._interface_type_api_name import InterfaceTypeApiName from foundry.v2.ontologies.models._modify_interface_object_rule_dict import ( ModifyInterfaceObjectRuleDict, ) # NOQA @@ -28,6 +29,8 @@ class ModifyInterfaceObjectRule(pydantic.BaseModel): """ModifyInterfaceObjectRule""" + interface_type_api_name: InterfaceTypeApiName = pydantic.Field(alias="interfaceTypeApiName") + type: Literal["modifyInterfaceObject"] = "modifyInterfaceObject" model_config = {"extra": "allow"} diff --git a/foundry/v2/ontologies/models/_modify_interface_object_rule_dict.py b/foundry/v2/ontologies/models/_modify_interface_object_rule_dict.py index 2ce1db20..2c2aec9d 100644 --- a/foundry/v2/ontologies/models/_modify_interface_object_rule_dict.py +++ b/foundry/v2/ontologies/models/_modify_interface_object_rule_dict.py @@ -19,10 +19,14 @@ from typing_extensions import TypedDict +from foundry.v2.ontologies.models._interface_type_api_name import InterfaceTypeApiName + class ModifyInterfaceObjectRuleDict(TypedDict): """ModifyInterfaceObjectRule""" __pydantic_config__ = {"extra": "allow"} # type: ignore + interfaceTypeApiName: InterfaceTypeApiName + type: Literal["modifyInterfaceObject"] diff --git a/foundry/v2/ontologies/models/_ontology_interface_object_type.py b/foundry/v2/ontologies/models/_ontology_interface_object_type.py new file mode 100644 index 00000000..ee23d38a --- /dev/null +++ b/foundry/v2/ontologies/models/_ontology_interface_object_type.py @@ -0,0 +1,42 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +import pydantic + +from foundry.v2.ontologies.models._interface_type_api_name import InterfaceTypeApiName +from foundry.v2.ontologies.models._ontology_interface_object_type_dict import ( + OntologyInterfaceObjectTypeDict, +) # NOQA + + +class OntologyInterfaceObjectType(pydantic.BaseModel): + """OntologyInterfaceObjectType""" + + interface_type_api_name: InterfaceTypeApiName = pydantic.Field(alias="interfaceTypeApiName") + + type: Literal["interfaceObject"] = "interfaceObject" + + model_config = {"extra": "allow"} + + def to_dict(self) -> OntologyInterfaceObjectTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + OntologyInterfaceObjectTypeDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_ontology_interface_object_type_dict.py b/foundry/v2/ontologies/models/_ontology_interface_object_type_dict.py new file mode 100644 index 00000000..cd9e1766 --- /dev/null +++ b/foundry/v2/ontologies/models/_ontology_interface_object_type_dict.py @@ -0,0 +1,32 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + +from foundry.v2.ontologies.models._interface_type_api_name import InterfaceTypeApiName + + +class OntologyInterfaceObjectTypeDict(TypedDict): + """OntologyInterfaceObjectType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + interfaceTypeApiName: InterfaceTypeApiName + + type: Literal["interfaceObject"] diff --git a/foundry/v2/ontologies/models/_ontology_object_type_reference_type.py b/foundry/v2/ontologies/models/_ontology_object_type_reference_type.py new file mode 100644 index 00000000..572246a8 --- /dev/null +++ b/foundry/v2/ontologies/models/_ontology_object_type_reference_type.py @@ -0,0 +1,39 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal +from typing import cast + +import pydantic + +from foundry.v2.ontologies.models._ontology_object_type_reference_type_dict import ( + OntologyObjectTypeReferenceTypeDict, +) # NOQA + + +class OntologyObjectTypeReferenceType(pydantic.BaseModel): + """OntologyObjectTypeReferenceType""" + + type: Literal["objectType"] = "objectType" + + model_config = {"extra": "allow"} + + def to_dict(self) -> OntologyObjectTypeReferenceTypeDict: + """Return the dictionary representation of the model using the field aliases.""" + return cast( + OntologyObjectTypeReferenceTypeDict, self.model_dump(by_alias=True, exclude_unset=True) + ) diff --git a/foundry/v2/ontologies/models/_ontology_object_type_reference_type_dict.py b/foundry/v2/ontologies/models/_ontology_object_type_reference_type_dict.py new file mode 100644 index 00000000..800c4500 --- /dev/null +++ b/foundry/v2/ontologies/models/_ontology_object_type_reference_type_dict.py @@ -0,0 +1,28 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +from typing_extensions import TypedDict + + +class OntologyObjectTypeReferenceTypeDict(TypedDict): + """OntologyObjectTypeReferenceType""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + type: Literal["objectType"] diff --git a/foundry/v2/ontologies/models/_property_type_status.py b/foundry/v2/ontologies/models/_property_type_status.py new file mode 100644 index 00000000..9d91d62b --- /dev/null +++ b/foundry/v2/ontologies/models/_property_type_status.py @@ -0,0 +1,45 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +import pydantic +from typing_extensions import Annotated + +from foundry.v2.ontologies.models._active_property_type_status import ( + ActivePropertyTypeStatus, +) # NOQA +from foundry.v2.ontologies.models._deprecated_property_type_status import ( + DeprecatedPropertyTypeStatus, +) # NOQA +from foundry.v2.ontologies.models._example_property_type_status import ( + ExamplePropertyTypeStatus, +) # NOQA +from foundry.v2.ontologies.models._experimental_property_type_status import ( + ExperimentalPropertyTypeStatus, +) # NOQA + +PropertyTypeStatus = Annotated[ + Union[ + DeprecatedPropertyTypeStatus, + ActivePropertyTypeStatus, + ExperimentalPropertyTypeStatus, + ExamplePropertyTypeStatus, + ], + pydantic.Field(discriminator="type"), +] +"""The status to indicate whether the PropertyType is either Experimental, Active, Deprecated, or Example.""" diff --git a/foundry/v2/ontologies/models/_property_type_status_dict.py b/foundry/v2/ontologies/models/_property_type_status_dict.py new file mode 100644 index 00000000..0f1b5c78 --- /dev/null +++ b/foundry/v2/ontologies/models/_property_type_status_dict.py @@ -0,0 +1,45 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Union + +import pydantic +from typing_extensions import Annotated + +from foundry.v2.ontologies.models._active_property_type_status_dict import ( + ActivePropertyTypeStatusDict, +) # NOQA +from foundry.v2.ontologies.models._deprecated_property_type_status_dict import ( + DeprecatedPropertyTypeStatusDict, +) # NOQA +from foundry.v2.ontologies.models._example_property_type_status_dict import ( + ExamplePropertyTypeStatusDict, +) # NOQA +from foundry.v2.ontologies.models._experimental_property_type_status_dict import ( + ExperimentalPropertyTypeStatusDict, +) # NOQA + +PropertyTypeStatusDict = Annotated[ + Union[ + DeprecatedPropertyTypeStatusDict, + ActivePropertyTypeStatusDict, + ExperimentalPropertyTypeStatusDict, + ExamplePropertyTypeStatusDict, + ], + pydantic.Field(discriminator="type"), +] +"""The status to indicate whether the PropertyType is either Experimental, Active, Deprecated, or Example.""" diff --git a/foundry/v2/ontologies/models/_property_type_visibility.py b/foundry/v2/ontologies/models/_property_type_visibility.py new file mode 100644 index 00000000..9c1bd5b6 --- /dev/null +++ b/foundry/v2/ontologies/models/_property_type_visibility.py @@ -0,0 +1,21 @@ +# Copyright 2024 Palantir Technologies, Inc. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + + +from __future__ import annotations + +from typing import Literal + +PropertyTypeVisibility = Literal["NORMAL", "PROMINENT", "HIDDEN"] +"""PropertyTypeVisibility""" diff --git a/foundry/v2/ontologies/models/_property_v2.py b/foundry/v2/ontologies/models/_property_v2.py index 4c76e6f4..4e683791 100644 --- a/foundry/v2/ontologies/models/_property_v2.py +++ b/foundry/v2/ontologies/models/_property_v2.py @@ -23,6 +23,8 @@ from foundry.v2.core.models._display_name import DisplayName from foundry.v2.ontologies.models._object_property_type import ObjectPropertyType from foundry.v2.ontologies.models._property_type_rid import PropertyTypeRid +from foundry.v2.ontologies.models._property_type_status import PropertyTypeStatus +from foundry.v2.ontologies.models._property_type_visibility import PropertyTypeVisibility # NOQA from foundry.v2.ontologies.models._property_v2_dict import PropertyV2Dict @@ -37,6 +39,10 @@ class PropertyV2(pydantic.BaseModel): rid: PropertyTypeRid + status: Optional[PropertyTypeStatus] = None + + visibility: Optional[PropertyTypeVisibility] = None + model_config = {"extra": "allow"} def to_dict(self) -> PropertyV2Dict: diff --git a/foundry/v2/ontologies/models/_property_v2_dict.py b/foundry/v2/ontologies/models/_property_v2_dict.py index 0b22f003..a6c6bcc2 100644 --- a/foundry/v2/ontologies/models/_property_v2_dict.py +++ b/foundry/v2/ontologies/models/_property_v2_dict.py @@ -22,6 +22,8 @@ from foundry.v2.core.models._display_name import DisplayName from foundry.v2.ontologies.models._object_property_type_dict import ObjectPropertyTypeDict # NOQA from foundry.v2.ontologies.models._property_type_rid import PropertyTypeRid +from foundry.v2.ontologies.models._property_type_status_dict import PropertyTypeStatusDict # NOQA +from foundry.v2.ontologies.models._property_type_visibility import PropertyTypeVisibility # NOQA class PropertyV2Dict(TypedDict): @@ -36,3 +38,7 @@ class PropertyV2Dict(TypedDict): dataType: ObjectPropertyTypeDict rid: PropertyTypeRid + + status: NotRequired[PropertyTypeStatusDict] + + visibility: NotRequired[PropertyTypeVisibility] diff --git a/foundry/v2/orchestration/build.py b/foundry/v2/orchestration/build.py index e27d3f38..91482e74 100644 --- a/foundry/v2/orchestration/build.py +++ b/foundry/v2/orchestration/build.py @@ -46,6 +46,46 @@ class BuildClient: def __init__(self, auth: Auth, hostname: str) -> None: self._api_client = ApiClient(auth=auth, hostname=hostname) + @pydantic.validate_call + @handle_unexpected + def cancel( + self, + build_rid: BuildRid, + *, + preview: Optional[PreviewMode] = None, + request_timeout: Optional[Annotated[pydantic.StrictInt, pydantic.Field(gt=0)]] = None, + ) -> None: + """ + Request a cancellation for all unfinished jobs in a build. The build's status will not update immediately. This endpoint is asynchronous and a success response indicates that the cancellation request has been acknowledged and the build is expected to be canceled soon. If the build has already finished or finishes shortly after the request and before the cancellation, the build will not change. + + :param build_rid: buildRid + :type build_rid: BuildRid + :param preview: preview + :type preview: Optional[PreviewMode] + :param request_timeout: timeout setting for this request in seconds. + :type request_timeout: Optional[int] + :return: Returns the result object. + :rtype: None + """ + + return self._api_client.call_api( + RequestInfo( + method="POST", + resource_path="/v2/orchestration/builds/{buildRid}/cancel", + query_params={ + "preview": preview, + }, + path_params={ + "buildRid": build_rid, + }, + header_params={}, + body=None, + body_type=None, + response_type=None, + request_timeout=request_timeout, + ), + ) + @pydantic.validate_call @handle_unexpected def create( @@ -74,7 +114,7 @@ def create( :type branch_name: Optional[BranchName] :param force_build: :type force_build: Optional[ForceBuild] - :param notifications_enabled: + :param notifications_enabled: The notification will be sent to the user that has most recently edited the schedule. No notification will be sent if the schedule has `scopeMode` set to `ProjectScope`. :type notifications_enabled: Optional[NotificationsEnabled] :param preview: preview :type preview: Optional[PreviewMode] diff --git a/foundry/v2/orchestration/models/__init__.py b/foundry/v2/orchestration/models/__init__.py index 372dcdcb..7cb5b863 100644 --- a/foundry/v2/orchestration/models/__init__.py +++ b/foundry/v2/orchestration/models/__init__.py @@ -27,29 +27,29 @@ from foundry.v2.orchestration.models._buildable_rid import BuildableRid from foundry.v2.orchestration.models._connecting_target import ConnectingTarget from foundry.v2.orchestration.models._connecting_target_dict import ConnectingTargetDict -from foundry.v2.orchestration.models._create_schedule_request_action_build_target_connecting_target_dict import ( - CreateScheduleRequestActionBuildTargetConnectingTargetDict, +from foundry.v2.orchestration.models._create_schedule_request_action_dict import ( + CreateScheduleRequestActionDict, ) # NOQA -from foundry.v2.orchestration.models._create_schedule_request_action_build_target_dict import ( - CreateScheduleRequestActionBuildTargetDict, +from foundry.v2.orchestration.models._create_schedule_request_build_target_dict import ( + CreateScheduleRequestBuildTargetDict, ) # NOQA -from foundry.v2.orchestration.models._create_schedule_request_action_build_target_manual_target_dict import ( - CreateScheduleRequestActionBuildTargetManualTargetDict, +from foundry.v2.orchestration.models._create_schedule_request_connecting_target_dict import ( + CreateScheduleRequestConnectingTargetDict, ) # NOQA -from foundry.v2.orchestration.models._create_schedule_request_action_build_target_upstream_target_dict import ( - CreateScheduleRequestActionBuildTargetUpstreamTargetDict, +from foundry.v2.orchestration.models._create_schedule_request_manual_target_dict import ( + CreateScheduleRequestManualTargetDict, ) # NOQA -from foundry.v2.orchestration.models._create_schedule_request_action_dict import ( - CreateScheduleRequestActionDict, +from foundry.v2.orchestration.models._create_schedule_request_project_scope_dict import ( + CreateScheduleRequestProjectScopeDict, ) # NOQA from foundry.v2.orchestration.models._create_schedule_request_scope_mode_dict import ( CreateScheduleRequestScopeModeDict, ) # NOQA -from foundry.v2.orchestration.models._create_schedule_request_scope_mode_project_scope_dict import ( - CreateScheduleRequestScopeModeProjectScopeDict, +from foundry.v2.orchestration.models._create_schedule_request_upstream_target_dict import ( + CreateScheduleRequestUpstreamTargetDict, ) # NOQA -from foundry.v2.orchestration.models._create_schedule_request_scope_mode_user_scope_dict import ( - CreateScheduleRequestScopeModeUserScopeDict, +from foundry.v2.orchestration.models._create_schedule_request_user_scope_dict import ( + CreateScheduleRequestUserScopeDict, ) # NOQA from foundry.v2.orchestration.models._cron_expression import CronExpression from foundry.v2.orchestration.models._dataset_updated_trigger import DatasetUpdatedTrigger # NOQA @@ -77,29 +77,29 @@ from foundry.v2.orchestration.models._or_trigger_dict import OrTriggerDict from foundry.v2.orchestration.models._project_scope import ProjectScope from foundry.v2.orchestration.models._project_scope_dict import ProjectScopeDict -from foundry.v2.orchestration.models._replace_schedule_request_action_build_target_connecting_target_dict import ( - ReplaceScheduleRequestActionBuildTargetConnectingTargetDict, +from foundry.v2.orchestration.models._replace_schedule_request_action_dict import ( + ReplaceScheduleRequestActionDict, ) # NOQA -from foundry.v2.orchestration.models._replace_schedule_request_action_build_target_dict import ( - ReplaceScheduleRequestActionBuildTargetDict, +from foundry.v2.orchestration.models._replace_schedule_request_build_target_dict import ( + ReplaceScheduleRequestBuildTargetDict, ) # NOQA -from foundry.v2.orchestration.models._replace_schedule_request_action_build_target_manual_target_dict import ( - ReplaceScheduleRequestActionBuildTargetManualTargetDict, +from foundry.v2.orchestration.models._replace_schedule_request_connecting_target_dict import ( + ReplaceScheduleRequestConnectingTargetDict, ) # NOQA -from foundry.v2.orchestration.models._replace_schedule_request_action_build_target_upstream_target_dict import ( - ReplaceScheduleRequestActionBuildTargetUpstreamTargetDict, +from foundry.v2.orchestration.models._replace_schedule_request_manual_target_dict import ( + ReplaceScheduleRequestManualTargetDict, ) # NOQA -from foundry.v2.orchestration.models._replace_schedule_request_action_dict import ( - ReplaceScheduleRequestActionDict, +from foundry.v2.orchestration.models._replace_schedule_request_project_scope_dict import ( + ReplaceScheduleRequestProjectScopeDict, ) # NOQA from foundry.v2.orchestration.models._replace_schedule_request_scope_mode_dict import ( ReplaceScheduleRequestScopeModeDict, ) # NOQA -from foundry.v2.orchestration.models._replace_schedule_request_scope_mode_project_scope_dict import ( - ReplaceScheduleRequestScopeModeProjectScopeDict, +from foundry.v2.orchestration.models._replace_schedule_request_upstream_target_dict import ( + ReplaceScheduleRequestUpstreamTargetDict, ) # NOQA -from foundry.v2.orchestration.models._replace_schedule_request_scope_mode_user_scope_dict import ( - ReplaceScheduleRequestScopeModeUserScopeDict, +from foundry.v2.orchestration.models._replace_schedule_request_user_scope_dict import ( + ReplaceScheduleRequestUserScopeDict, ) # NOQA from foundry.v2.orchestration.models._retry_backoff_duration import RetryBackoffDuration from foundry.v2.orchestration.models._retry_backoff_duration_dict import ( @@ -159,14 +159,14 @@ "BuildableRid", "ConnectingTarget", "ConnectingTargetDict", - "CreateScheduleRequestActionBuildTargetConnectingTargetDict", - "CreateScheduleRequestActionBuildTargetDict", - "CreateScheduleRequestActionBuildTargetManualTargetDict", - "CreateScheduleRequestActionBuildTargetUpstreamTargetDict", "CreateScheduleRequestActionDict", + "CreateScheduleRequestBuildTargetDict", + "CreateScheduleRequestConnectingTargetDict", + "CreateScheduleRequestManualTargetDict", + "CreateScheduleRequestProjectScopeDict", "CreateScheduleRequestScopeModeDict", - "CreateScheduleRequestScopeModeProjectScopeDict", - "CreateScheduleRequestScopeModeUserScopeDict", + "CreateScheduleRequestUpstreamTargetDict", + "CreateScheduleRequestUserScopeDict", "CronExpression", "DatasetUpdatedTrigger", "DatasetUpdatedTriggerDict", @@ -185,14 +185,14 @@ "OrTriggerDict", "ProjectScope", "ProjectScopeDict", - "ReplaceScheduleRequestActionBuildTargetConnectingTargetDict", - "ReplaceScheduleRequestActionBuildTargetDict", - "ReplaceScheduleRequestActionBuildTargetManualTargetDict", - "ReplaceScheduleRequestActionBuildTargetUpstreamTargetDict", "ReplaceScheduleRequestActionDict", + "ReplaceScheduleRequestBuildTargetDict", + "ReplaceScheduleRequestConnectingTargetDict", + "ReplaceScheduleRequestManualTargetDict", + "ReplaceScheduleRequestProjectScopeDict", "ReplaceScheduleRequestScopeModeDict", - "ReplaceScheduleRequestScopeModeProjectScopeDict", - "ReplaceScheduleRequestScopeModeUserScopeDict", + "ReplaceScheduleRequestUpstreamTargetDict", + "ReplaceScheduleRequestUserScopeDict", "RetryBackoffDuration", "RetryBackoffDurationDict", "RetryCount", diff --git a/foundry/v2/orchestration/models/_build.py b/foundry/v2/orchestration/models/_build.py index 5be1e09f..7a8db007 100644 --- a/foundry/v2/orchestration/models/_build.py +++ b/foundry/v2/orchestration/models/_build.py @@ -35,7 +35,7 @@ class Build(pydantic.BaseModel): """Build""" rid: BuildRid - """The RID of a build""" + """The RID of a build.""" branch_name: BranchName = pydantic.Field(alias="branchName") """The branch that the build is running on.""" diff --git a/foundry/v2/orchestration/models/_build_dict.py b/foundry/v2/orchestration/models/_build_dict.py index 5ebe1561..22f2d516 100644 --- a/foundry/v2/orchestration/models/_build_dict.py +++ b/foundry/v2/orchestration/models/_build_dict.py @@ -36,7 +36,7 @@ class BuildDict(TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore rid: BuildRid - """The RID of a build""" + """The RID of a build.""" branchName: BranchName """The branch that the build is running on.""" diff --git a/foundry/v2/orchestration/models/_build_rid.py b/foundry/v2/orchestration/models/_build_rid.py index 07144610..b75f4143 100644 --- a/foundry/v2/orchestration/models/_build_rid.py +++ b/foundry/v2/orchestration/models/_build_rid.py @@ -18,4 +18,4 @@ from foundry._core.utils import RID BuildRid = RID -"""The RID of a build""" +"""The RID of a build.""" diff --git a/foundry/v2/orchestration/models/_create_schedule_request_action_dict.py b/foundry/v2/orchestration/models/_create_schedule_request_action_dict.py index c124bbdd..d434dca4 100644 --- a/foundry/v2/orchestration/models/_create_schedule_request_action_dict.py +++ b/foundry/v2/orchestration/models/_create_schedule_request_action_dict.py @@ -20,8 +20,8 @@ from foundry.v2.datasets.models._branch_name import BranchName from foundry.v2.orchestration.models._abort_on_failure import AbortOnFailure -from foundry.v2.orchestration.models._create_schedule_request_action_build_target_dict import ( - CreateScheduleRequestActionBuildTargetDict, +from foundry.v2.orchestration.models._create_schedule_request_build_target_dict import ( + CreateScheduleRequestBuildTargetDict, ) # NOQA from foundry.v2.orchestration.models._fallback_branches import FallbackBranches from foundry.v2.orchestration.models._force_build import ForceBuild @@ -52,4 +52,4 @@ class CreateScheduleRequestActionDict(TypedDict): notificationsEnabled: NotRequired[NotificationsEnabled] - target: CreateScheduleRequestActionBuildTargetDict + target: CreateScheduleRequestBuildTargetDict diff --git a/foundry/v2/orchestration/models/_create_schedule_request_action_build_target_dict.py b/foundry/v2/orchestration/models/_create_schedule_request_build_target_dict.py similarity index 52% rename from foundry/v2/orchestration/models/_create_schedule_request_action_build_target_dict.py rename to foundry/v2/orchestration/models/_create_schedule_request_build_target_dict.py index ce19a566..b8183ddd 100644 --- a/foundry/v2/orchestration/models/_create_schedule_request_action_build_target_dict.py +++ b/foundry/v2/orchestration/models/_create_schedule_request_build_target_dict.py @@ -20,21 +20,21 @@ import pydantic from typing_extensions import Annotated -from foundry.v2.orchestration.models._create_schedule_request_action_build_target_connecting_target_dict import ( - CreateScheduleRequestActionBuildTargetConnectingTargetDict, +from foundry.v2.orchestration.models._create_schedule_request_connecting_target_dict import ( + CreateScheduleRequestConnectingTargetDict, ) # NOQA -from foundry.v2.orchestration.models._create_schedule_request_action_build_target_manual_target_dict import ( - CreateScheduleRequestActionBuildTargetManualTargetDict, +from foundry.v2.orchestration.models._create_schedule_request_manual_target_dict import ( + CreateScheduleRequestManualTargetDict, ) # NOQA -from foundry.v2.orchestration.models._create_schedule_request_action_build_target_upstream_target_dict import ( - CreateScheduleRequestActionBuildTargetUpstreamTargetDict, +from foundry.v2.orchestration.models._create_schedule_request_upstream_target_dict import ( + CreateScheduleRequestUpstreamTargetDict, ) # NOQA -CreateScheduleRequestActionBuildTargetDict = Annotated[ +CreateScheduleRequestBuildTargetDict = Annotated[ Union[ - CreateScheduleRequestActionBuildTargetUpstreamTargetDict, - CreateScheduleRequestActionBuildTargetManualTargetDict, - CreateScheduleRequestActionBuildTargetConnectingTargetDict, + CreateScheduleRequestUpstreamTargetDict, + CreateScheduleRequestManualTargetDict, + CreateScheduleRequestConnectingTargetDict, ], pydantic.Field(discriminator="type"), ] diff --git a/foundry/v2/orchestration/models/_create_schedule_request_action_build_target_connecting_target_dict.py b/foundry/v2/orchestration/models/_create_schedule_request_connecting_target_dict.py similarity index 89% rename from foundry/v2/orchestration/models/_create_schedule_request_action_build_target_connecting_target_dict.py rename to foundry/v2/orchestration/models/_create_schedule_request_connecting_target_dict.py index b6a1770f..e29288e2 100644 --- a/foundry/v2/orchestration/models/_create_schedule_request_action_build_target_connecting_target_dict.py +++ b/foundry/v2/orchestration/models/_create_schedule_request_connecting_target_dict.py @@ -24,8 +24,8 @@ from foundry.v2.orchestration.models._buildable_rid import BuildableRid -class CreateScheduleRequestActionBuildTargetConnectingTargetDict(TypedDict): - """CreateScheduleRequestActionBuildTargetConnectingTarget""" +class CreateScheduleRequestConnectingTargetDict(TypedDict): + """CreateScheduleRequestConnectingTarget""" __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry/v2/orchestration/models/_create_schedule_request_action_build_target_manual_target_dict.py b/foundry/v2/orchestration/models/_create_schedule_request_manual_target_dict.py similarity index 87% rename from foundry/v2/orchestration/models/_create_schedule_request_action_build_target_manual_target_dict.py rename to foundry/v2/orchestration/models/_create_schedule_request_manual_target_dict.py index c9e69976..3b4cf3d2 100644 --- a/foundry/v2/orchestration/models/_create_schedule_request_action_build_target_manual_target_dict.py +++ b/foundry/v2/orchestration/models/_create_schedule_request_manual_target_dict.py @@ -23,8 +23,8 @@ from foundry.v2.orchestration.models._buildable_rid import BuildableRid -class CreateScheduleRequestActionBuildTargetManualTargetDict(TypedDict): - """CreateScheduleRequestActionBuildTargetManualTarget""" +class CreateScheduleRequestManualTargetDict(TypedDict): + """CreateScheduleRequestManualTarget""" __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry/v2/orchestration/models/_create_schedule_request_scope_mode_project_scope_dict.py b/foundry/v2/orchestration/models/_create_schedule_request_project_scope_dict.py similarity index 88% rename from foundry/v2/orchestration/models/_create_schedule_request_scope_mode_project_scope_dict.py rename to foundry/v2/orchestration/models/_create_schedule_request_project_scope_dict.py index 953718f5..5e489efa 100644 --- a/foundry/v2/orchestration/models/_create_schedule_request_scope_mode_project_scope_dict.py +++ b/foundry/v2/orchestration/models/_create_schedule_request_project_scope_dict.py @@ -23,8 +23,8 @@ from foundry.v2.filesystem.models._project_rid import ProjectRid -class CreateScheduleRequestScopeModeProjectScopeDict(TypedDict): - """CreateScheduleRequestScopeModeProjectScope""" +class CreateScheduleRequestProjectScopeDict(TypedDict): + """CreateScheduleRequestProjectScope""" __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry/v2/orchestration/models/_create_schedule_request_scope_mode_dict.py b/foundry/v2/orchestration/models/_create_schedule_request_scope_mode_dict.py index 9b8f76c2..a162aacf 100644 --- a/foundry/v2/orchestration/models/_create_schedule_request_scope_mode_dict.py +++ b/foundry/v2/orchestration/models/_create_schedule_request_scope_mode_dict.py @@ -20,17 +20,15 @@ import pydantic from typing_extensions import Annotated -from foundry.v2.orchestration.models._create_schedule_request_scope_mode_project_scope_dict import ( - CreateScheduleRequestScopeModeProjectScopeDict, +from foundry.v2.orchestration.models._create_schedule_request_project_scope_dict import ( + CreateScheduleRequestProjectScopeDict, ) # NOQA -from foundry.v2.orchestration.models._create_schedule_request_scope_mode_user_scope_dict import ( - CreateScheduleRequestScopeModeUserScopeDict, +from foundry.v2.orchestration.models._create_schedule_request_user_scope_dict import ( + CreateScheduleRequestUserScopeDict, ) # NOQA CreateScheduleRequestScopeModeDict = Annotated[ - Union[ - CreateScheduleRequestScopeModeProjectScopeDict, CreateScheduleRequestScopeModeUserScopeDict - ], + Union[CreateScheduleRequestProjectScopeDict, CreateScheduleRequestUserScopeDict], pydantic.Field(discriminator="type"), ] """The boundaries for the schedule build.""" diff --git a/foundry/v2/orchestration/models/_create_schedule_request_action_build_target_upstream_target_dict.py b/foundry/v2/orchestration/models/_create_schedule_request_upstream_target_dict.py similarity index 89% rename from foundry/v2/orchestration/models/_create_schedule_request_action_build_target_upstream_target_dict.py rename to foundry/v2/orchestration/models/_create_schedule_request_upstream_target_dict.py index 12babc08..e5907337 100644 --- a/foundry/v2/orchestration/models/_create_schedule_request_action_build_target_upstream_target_dict.py +++ b/foundry/v2/orchestration/models/_create_schedule_request_upstream_target_dict.py @@ -24,8 +24,8 @@ from foundry.v2.orchestration.models._buildable_rid import BuildableRid -class CreateScheduleRequestActionBuildTargetUpstreamTargetDict(TypedDict): - """CreateScheduleRequestActionBuildTargetUpstreamTarget""" +class CreateScheduleRequestUpstreamTargetDict(TypedDict): + """CreateScheduleRequestUpstreamTarget""" __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry/v2/orchestration/models/_create_schedule_request_scope_mode_user_scope_dict.py b/foundry/v2/orchestration/models/_create_schedule_request_user_scope_dict.py similarity index 87% rename from foundry/v2/orchestration/models/_create_schedule_request_scope_mode_user_scope_dict.py rename to foundry/v2/orchestration/models/_create_schedule_request_user_scope_dict.py index a91d25c0..327bb0c8 100644 --- a/foundry/v2/orchestration/models/_create_schedule_request_scope_mode_user_scope_dict.py +++ b/foundry/v2/orchestration/models/_create_schedule_request_user_scope_dict.py @@ -20,8 +20,8 @@ from typing_extensions import TypedDict -class CreateScheduleRequestScopeModeUserScopeDict(TypedDict): - """CreateScheduleRequestScopeModeUserScope""" +class CreateScheduleRequestUserScopeDict(TypedDict): + """CreateScheduleRequestUserScope""" __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry/v2/orchestration/models/_notifications_enabled.py b/foundry/v2/orchestration/models/_notifications_enabled.py index b948b973..1c65a66b 100644 --- a/foundry/v2/orchestration/models/_notifications_enabled.py +++ b/foundry/v2/orchestration/models/_notifications_enabled.py @@ -18,4 +18,7 @@ import pydantic NotificationsEnabled = pydantic.StrictBool -"""Whether to receive a notification at the end of scheduled builds.""" +""" +Whether to receive a notification at the end of the build. +The notification will be sent to the user that has performed the request. +""" diff --git a/foundry/v2/orchestration/models/_replace_schedule_request_action_dict.py b/foundry/v2/orchestration/models/_replace_schedule_request_action_dict.py index 6a405982..afc678d2 100644 --- a/foundry/v2/orchestration/models/_replace_schedule_request_action_dict.py +++ b/foundry/v2/orchestration/models/_replace_schedule_request_action_dict.py @@ -23,8 +23,8 @@ from foundry.v2.orchestration.models._fallback_branches import FallbackBranches from foundry.v2.orchestration.models._force_build import ForceBuild from foundry.v2.orchestration.models._notifications_enabled import NotificationsEnabled -from foundry.v2.orchestration.models._replace_schedule_request_action_build_target_dict import ( - ReplaceScheduleRequestActionBuildTargetDict, +from foundry.v2.orchestration.models._replace_schedule_request_build_target_dict import ( + ReplaceScheduleRequestBuildTargetDict, ) # NOQA from foundry.v2.orchestration.models._retry_backoff_duration_dict import ( RetryBackoffDurationDict, @@ -52,4 +52,4 @@ class ReplaceScheduleRequestActionDict(TypedDict): notificationsEnabled: NotRequired[NotificationsEnabled] - target: ReplaceScheduleRequestActionBuildTargetDict + target: ReplaceScheduleRequestBuildTargetDict diff --git a/foundry/v2/orchestration/models/_replace_schedule_request_action_build_target_dict.py b/foundry/v2/orchestration/models/_replace_schedule_request_build_target_dict.py similarity index 51% rename from foundry/v2/orchestration/models/_replace_schedule_request_action_build_target_dict.py rename to foundry/v2/orchestration/models/_replace_schedule_request_build_target_dict.py index f96c8269..9c757a8a 100644 --- a/foundry/v2/orchestration/models/_replace_schedule_request_action_build_target_dict.py +++ b/foundry/v2/orchestration/models/_replace_schedule_request_build_target_dict.py @@ -20,21 +20,21 @@ import pydantic from typing_extensions import Annotated -from foundry.v2.orchestration.models._replace_schedule_request_action_build_target_connecting_target_dict import ( - ReplaceScheduleRequestActionBuildTargetConnectingTargetDict, +from foundry.v2.orchestration.models._replace_schedule_request_connecting_target_dict import ( + ReplaceScheduleRequestConnectingTargetDict, ) # NOQA -from foundry.v2.orchestration.models._replace_schedule_request_action_build_target_manual_target_dict import ( - ReplaceScheduleRequestActionBuildTargetManualTargetDict, +from foundry.v2.orchestration.models._replace_schedule_request_manual_target_dict import ( + ReplaceScheduleRequestManualTargetDict, ) # NOQA -from foundry.v2.orchestration.models._replace_schedule_request_action_build_target_upstream_target_dict import ( - ReplaceScheduleRequestActionBuildTargetUpstreamTargetDict, +from foundry.v2.orchestration.models._replace_schedule_request_upstream_target_dict import ( + ReplaceScheduleRequestUpstreamTargetDict, ) # NOQA -ReplaceScheduleRequestActionBuildTargetDict = Annotated[ +ReplaceScheduleRequestBuildTargetDict = Annotated[ Union[ - ReplaceScheduleRequestActionBuildTargetUpstreamTargetDict, - ReplaceScheduleRequestActionBuildTargetManualTargetDict, - ReplaceScheduleRequestActionBuildTargetConnectingTargetDict, + ReplaceScheduleRequestUpstreamTargetDict, + ReplaceScheduleRequestManualTargetDict, + ReplaceScheduleRequestConnectingTargetDict, ], pydantic.Field(discriminator="type"), ] diff --git a/foundry/v2/orchestration/models/_replace_schedule_request_action_build_target_connecting_target_dict.py b/foundry/v2/orchestration/models/_replace_schedule_request_connecting_target_dict.py similarity index 89% rename from foundry/v2/orchestration/models/_replace_schedule_request_action_build_target_connecting_target_dict.py rename to foundry/v2/orchestration/models/_replace_schedule_request_connecting_target_dict.py index 38cd668d..3ed160d9 100644 --- a/foundry/v2/orchestration/models/_replace_schedule_request_action_build_target_connecting_target_dict.py +++ b/foundry/v2/orchestration/models/_replace_schedule_request_connecting_target_dict.py @@ -24,8 +24,8 @@ from foundry.v2.orchestration.models._buildable_rid import BuildableRid -class ReplaceScheduleRequestActionBuildTargetConnectingTargetDict(TypedDict): - """ReplaceScheduleRequestActionBuildTargetConnectingTarget""" +class ReplaceScheduleRequestConnectingTargetDict(TypedDict): + """ReplaceScheduleRequestConnectingTarget""" __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry/v2/orchestration/models/_replace_schedule_request_action_build_target_manual_target_dict.py b/foundry/v2/orchestration/models/_replace_schedule_request_manual_target_dict.py similarity index 87% rename from foundry/v2/orchestration/models/_replace_schedule_request_action_build_target_manual_target_dict.py rename to foundry/v2/orchestration/models/_replace_schedule_request_manual_target_dict.py index a4ee214b..b51925d9 100644 --- a/foundry/v2/orchestration/models/_replace_schedule_request_action_build_target_manual_target_dict.py +++ b/foundry/v2/orchestration/models/_replace_schedule_request_manual_target_dict.py @@ -23,8 +23,8 @@ from foundry.v2.orchestration.models._buildable_rid import BuildableRid -class ReplaceScheduleRequestActionBuildTargetManualTargetDict(TypedDict): - """ReplaceScheduleRequestActionBuildTargetManualTarget""" +class ReplaceScheduleRequestManualTargetDict(TypedDict): + """ReplaceScheduleRequestManualTarget""" __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry/v2/orchestration/models/_replace_schedule_request_scope_mode_project_scope_dict.py b/foundry/v2/orchestration/models/_replace_schedule_request_project_scope_dict.py similarity index 88% rename from foundry/v2/orchestration/models/_replace_schedule_request_scope_mode_project_scope_dict.py rename to foundry/v2/orchestration/models/_replace_schedule_request_project_scope_dict.py index 624ab46c..724c7004 100644 --- a/foundry/v2/orchestration/models/_replace_schedule_request_scope_mode_project_scope_dict.py +++ b/foundry/v2/orchestration/models/_replace_schedule_request_project_scope_dict.py @@ -23,8 +23,8 @@ from foundry.v2.filesystem.models._project_rid import ProjectRid -class ReplaceScheduleRequestScopeModeProjectScopeDict(TypedDict): - """ReplaceScheduleRequestScopeModeProjectScope""" +class ReplaceScheduleRequestProjectScopeDict(TypedDict): + """ReplaceScheduleRequestProjectScope""" __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry/v2/orchestration/models/_replace_schedule_request_scope_mode_dict.py b/foundry/v2/orchestration/models/_replace_schedule_request_scope_mode_dict.py index bf320ad6..c50557ca 100644 --- a/foundry/v2/orchestration/models/_replace_schedule_request_scope_mode_dict.py +++ b/foundry/v2/orchestration/models/_replace_schedule_request_scope_mode_dict.py @@ -20,18 +20,15 @@ import pydantic from typing_extensions import Annotated -from foundry.v2.orchestration.models._replace_schedule_request_scope_mode_project_scope_dict import ( - ReplaceScheduleRequestScopeModeProjectScopeDict, +from foundry.v2.orchestration.models._replace_schedule_request_project_scope_dict import ( + ReplaceScheduleRequestProjectScopeDict, ) # NOQA -from foundry.v2.orchestration.models._replace_schedule_request_scope_mode_user_scope_dict import ( - ReplaceScheduleRequestScopeModeUserScopeDict, +from foundry.v2.orchestration.models._replace_schedule_request_user_scope_dict import ( + ReplaceScheduleRequestUserScopeDict, ) # NOQA ReplaceScheduleRequestScopeModeDict = Annotated[ - Union[ - ReplaceScheduleRequestScopeModeProjectScopeDict, - ReplaceScheduleRequestScopeModeUserScopeDict, - ], + Union[ReplaceScheduleRequestProjectScopeDict, ReplaceScheduleRequestUserScopeDict], pydantic.Field(discriminator="type"), ] """The boundaries for the schedule build.""" diff --git a/foundry/v2/orchestration/models/_replace_schedule_request_action_build_target_upstream_target_dict.py b/foundry/v2/orchestration/models/_replace_schedule_request_upstream_target_dict.py similarity index 89% rename from foundry/v2/orchestration/models/_replace_schedule_request_action_build_target_upstream_target_dict.py rename to foundry/v2/orchestration/models/_replace_schedule_request_upstream_target_dict.py index 60062077..f416afc0 100644 --- a/foundry/v2/orchestration/models/_replace_schedule_request_action_build_target_upstream_target_dict.py +++ b/foundry/v2/orchestration/models/_replace_schedule_request_upstream_target_dict.py @@ -24,8 +24,8 @@ from foundry.v2.orchestration.models._buildable_rid import BuildableRid -class ReplaceScheduleRequestActionBuildTargetUpstreamTargetDict(TypedDict): - """ReplaceScheduleRequestActionBuildTargetUpstreamTarget""" +class ReplaceScheduleRequestUpstreamTargetDict(TypedDict): + """ReplaceScheduleRequestUpstreamTarget""" __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/foundry/v2/orchestration/models/_replace_schedule_request_scope_mode_user_scope_dict.py b/foundry/v2/orchestration/models/_replace_schedule_request_user_scope_dict.py similarity index 87% rename from foundry/v2/orchestration/models/_replace_schedule_request_scope_mode_user_scope_dict.py rename to foundry/v2/orchestration/models/_replace_schedule_request_user_scope_dict.py index 3b0c57e6..c0045362 100644 --- a/foundry/v2/orchestration/models/_replace_schedule_request_scope_mode_user_scope_dict.py +++ b/foundry/v2/orchestration/models/_replace_schedule_request_user_scope_dict.py @@ -20,8 +20,8 @@ from typing_extensions import TypedDict -class ReplaceScheduleRequestScopeModeUserScopeDict(TypedDict): - """ReplaceScheduleRequestScopeModeUserScope""" +class ReplaceScheduleRequestUserScopeDict(TypedDict): + """ReplaceScheduleRequestUserScope""" __pydantic_config__ = {"extra": "allow"} # type: ignore diff --git a/tests/test_discriminators.py b/tests/test_discriminators.py index 04a0a669..fe1fb815 100644 --- a/tests/test_discriminators.py +++ b/tests/test_discriminators.py @@ -19,6 +19,7 @@ from foundry.v1.core import models as models_core_v1 from foundry.v1.datasets import models as models_datasets_v1 from foundry.v1.geo import models as models_geo_v1 +from foundry.v1.mediasets import models as models_mediasets_v1 from foundry.v1.ontologies import models as models_ontologies_v1 from foundry.v2.admin import models as models_admin_v2 from foundry.v2.aip_agents import models as models_aip_agents_v2 @@ -28,6 +29,7 @@ from foundry.v2.filesystem import models as models_filesystem_v2 from foundry.v2.functions import models as models_functions_v2 from foundry.v2.geo import models as models_geo_v2 +from foundry.v2.mediasets import models as models_mediasets_v2 from foundry.v2.ontologies import models as models_ontologies_v2 from foundry.v2.orchestration import models as models_orchestration_v2 from foundry.v2.streams import models as models_streams_v2 @@ -44,6 +46,7 @@ def test_can_validate_types(): *[(models_core_v1, model_name) for model_name in dir(models_core_v1)], *[(models_datasets_v1, model_name) for model_name in dir(models_datasets_v1)], *[(models_geo_v1, model_name) for model_name in dir(models_geo_v1)], + *[(models_mediasets_v1, model_name) for model_name in dir(models_mediasets_v1)], *[(models_ontologies_v1, model_name) for model_name in dir(models_ontologies_v1)], *[(models_admin_v2, model_name) for model_name in dir(models_admin_v2)], *[(models_aip_agents_v2, model_name) for model_name in dir(models_aip_agents_v2)], @@ -53,6 +56,7 @@ def test_can_validate_types(): *[(models_filesystem_v2, model_name) for model_name in dir(models_filesystem_v2)], *[(models_functions_v2, model_name) for model_name in dir(models_functions_v2)], *[(models_geo_v2, model_name) for model_name in dir(models_geo_v2)], + *[(models_mediasets_v2, model_name) for model_name in dir(models_mediasets_v2)], *[(models_ontologies_v2, model_name) for model_name in dir(models_ontologies_v2)], *[(models_ontologies_v2, model_name) for model_name in dir(models_ontologies_v2)], *[(models_orchestration_v2, model_name) for model_name in dir(models_orchestration_v2)],