diff --git a/.idea/.gitignore b/.idea/.gitignore deleted file mode 100644 index 26d33521a..000000000 --- a/.idea/.gitignore +++ /dev/null @@ -1,3 +0,0 @@ -# Default ignored files -/shelf/ -/workspace.xml diff --git a/README.md b/README.md index 1975a853e..60f0fcfae 100644 --- a/README.md +++ b/README.md @@ -208,21 +208,22 @@ the [Pydantic error documentation](https://docs.pydantic.dev/latest/errors/error experience. See [Static Type Analysis](#static-types) below for more information. ### HTTP exceptions -Each operation includes a list of possible exceptions that can be thrown which can be thrown by the server, all of which inherit from `PalantirRPCException`. For example, an operation that interacts with datasets might throw a `DatasetNotFound` error, which is defined as follows: +Each operation includes a list of possible exceptions that can be thrown which can be thrown by the server, all of which inherit from `PalantirRPCException`. For example, an operation that interacts with dataset branches might throw a `BranchNotFound` error, which is defined as follows: ```python -class DatasetNotFoundParameters(TypedDict): - """The given Dataset could not be found.""" +class BranchNotFoundParameters(typing_extensions.TypedDict): + """The requested branch could not be found, or the client token does not have access to it.""" __pydantic_config__ = {"extra": "allow"} # type: ignore - datasetRid: DatasetRid + datasetRid: datasets_models.DatasetRid + branchName: datasets_models.BranchName @dataclass -class DatasetNotFound(NotFoundError): - name: Literal["DatasetNotFound"] - parameters: DatasetNotFoundParameters +class BranchNotFound(errors.NotFoundError): + name: typing.Literal["BranchNotFound"] + parameters: BranchNotFoundParameters error_instance_id: str ``` @@ -230,13 +231,13 @@ class DatasetNotFound(NotFoundError): As a user, you can catch this exception and handle it accordingly. ```python -from foundry_sdk.v2.datasets.errors import DatasetNotFound +from foundry_sdk.v1.datasets.errors import BranchNotFound try: response = client.datasets.Dataset.get(dataset_rid) ... -except DatasetNotFound as e: - print("There was an error with the request", e.parameters[...]) +except BranchNotFound as e: + print("Resource not found", e.parameters[...]) ``` @@ -258,13 +259,13 @@ catch a generic subclass of `PalantirRPCException` such as `BadRequestError` or ```python from foundry_sdk import PalantirRPCException -from foundry_sdk import UnauthorizedError +from foundry_sdk import NotFoundError try: api_response = client.datasets.Dataset.get(dataset_rid) ... -except UnauthorizedError as e: - print("There was an error with the request", e) +except NotFoundError as e: + print("Resource not found", e) except PalantirRPCException as e: print("Another HTTP exception occurred", e) @@ -553,6 +554,7 @@ Namespace | Resource | Operation | HTTP request | **Datasets** | Branch | [**list**](docs/v2/Datasets/Branch.md#list) | **GET** /v2/datasets/{datasetRid}/branches | **Datasets** | Dataset | [**create**](docs/v2/Datasets/Dataset.md#create) | **POST** /v2/datasets | **Datasets** | Dataset | [**get**](docs/v2/Datasets/Dataset.md#get) | **GET** /v2/datasets/{datasetRid} | +**Datasets** | Dataset | [**get_schedules**](docs/v2/Datasets/Dataset.md#get_schedules) | **GET** /v2/datasets/{datasetRid}/getSchedules | **Datasets** | Dataset | [**read_table**](docs/v2/Datasets/Dataset.md#read_table) | **GET** /v2/datasets/{datasetRid}/readTable | **Datasets** | File | [**content**](docs/v2/Datasets/File.md#content) | **GET** /v2/datasets/{datasetRid}/files/{filePath}/content | **Datasets** | File | [**delete**](docs/v2/Datasets/File.md#delete) | **DELETE** /v2/datasets/{datasetRid}/files/{filePath} | @@ -604,6 +606,7 @@ Namespace | Resource | Operation | HTTP request | **Ontologies** | AttachmentProperty | [**get_attachment_by_rid**](docs/v2/Ontologies/AttachmentProperty.md#get_attachment_by_rid) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid} | **Ontologies** | AttachmentProperty | [**read_attachment**](docs/v2/Ontologies/AttachmentProperty.md#read_attachment) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/content | **Ontologies** | AttachmentProperty | [**read_attachment_by_rid**](docs/v2/Ontologies/AttachmentProperty.md#read_attachment_by_rid) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/attachments/{property}/{attachmentRid}/content | +**Ontologies** | CipherTextProperty | [**decrypt**](docs/v2/Ontologies/CipherTextProperty.md#decrypt) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/ciphertexts/{property}/decrypt | **Ontologies** | LinkedObject | [**get_linked_object**](docs/v2/Ontologies/LinkedObject.md#get_linked_object) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType}/{linkedObjectPrimaryKey} | **Ontologies** | LinkedObject | [**list_linked_objects**](docs/v2/Ontologies/LinkedObject.md#list_linked_objects) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/links/{linkType} | **Ontologies** | MediaReferenceProperty | [**get_media_content**](docs/v2/Ontologies/MediaReferenceProperty.md#get_media_content) | **GET** /v2/ontologies/{ontology}/objects/{objectType}/{primaryKey}/media/{property}/content | @@ -999,6 +1002,7 @@ Namespace | Name | Import | **Core** | [Reference](docs/v2/Core/models/Reference.md) | `from foundry_sdk.v2.core.models import Reference` | **Core** | [ReleaseStatus](docs/v2/Core/models/ReleaseStatus.md) | `from foundry_sdk.v2.core.models import ReleaseStatus` | **Core** | [RoleId](docs/v2/Core/models/RoleId.md) | `from foundry_sdk.v2.core.models import RoleId` | +**Core** | [ScheduleRid](docs/v2/Core/models/ScheduleRid.md) | `from foundry_sdk.v2.core.models import ScheduleRid` | **Core** | [ShortType](docs/v2/Core/models/ShortType.md) | `from foundry_sdk.v2.core.models import ShortType` | **Core** | [SizeBytes](docs/v2/Core/models/SizeBytes.md) | `from foundry_sdk.v2.core.models import SizeBytes` | **Core** | [StreamSchema](docs/v2/Core/models/StreamSchema.md) | `from foundry_sdk.v2.core.models import StreamSchema` | @@ -1027,6 +1031,7 @@ Namespace | Name | Import | **Datasets** | [FileUpdatedTime](docs/v2/Datasets/models/FileUpdatedTime.md) | `from foundry_sdk.v2.datasets.models import FileUpdatedTime` | **Datasets** | [ListBranchesResponse](docs/v2/Datasets/models/ListBranchesResponse.md) | `from foundry_sdk.v2.datasets.models import ListBranchesResponse` | **Datasets** | [ListFilesResponse](docs/v2/Datasets/models/ListFilesResponse.md) | `from foundry_sdk.v2.datasets.models import ListFilesResponse` | +**Datasets** | [ListSchedulesResponse](docs/v2/Datasets/models/ListSchedulesResponse.md) | `from foundry_sdk.v2.datasets.models import ListSchedulesResponse` | **Datasets** | [TableExportFormat](docs/v2/Datasets/models/TableExportFormat.md) | `from foundry_sdk.v2.datasets.models import TableExportFormat` | **Datasets** | [Transaction](docs/v2/Datasets/models/Transaction.md) | `from foundry_sdk.v2.datasets.models import Transaction` | **Datasets** | [TransactionCreatedTime](docs/v2/Datasets/models/TransactionCreatedTime.md) | `from foundry_sdk.v2.datasets.models import TransactionCreatedTime` | @@ -1482,7 +1487,6 @@ Namespace | Name | Import | **Orchestration** | [RetryCount](docs/v2/Orchestration/models/RetryCount.md) | `from foundry_sdk.v2.orchestration.models import RetryCount` | **Orchestration** | [Schedule](docs/v2/Orchestration/models/Schedule.md) | `from foundry_sdk.v2.orchestration.models import Schedule` | **Orchestration** | [SchedulePaused](docs/v2/Orchestration/models/SchedulePaused.md) | `from foundry_sdk.v2.orchestration.models import SchedulePaused` | -**Orchestration** | [ScheduleRid](docs/v2/Orchestration/models/ScheduleRid.md) | `from foundry_sdk.v2.orchestration.models import ScheduleRid` | **Orchestration** | [ScheduleRun](docs/v2/Orchestration/models/ScheduleRun.md) | `from foundry_sdk.v2.orchestration.models import ScheduleRun` | **Orchestration** | [ScheduleRunError](docs/v2/Orchestration/models/ScheduleRunError.md) | `from foundry_sdk.v2.orchestration.models import ScheduleRunError` | **Orchestration** | [ScheduleRunErrorName](docs/v2/Orchestration/models/ScheduleRunErrorName.md) | `from foundry_sdk.v2.orchestration.models import ScheduleRunErrorName` | @@ -1885,6 +1889,7 @@ Namespace | Name | Import | **Datasets** | FileNotFound | `from foundry_sdk.v2.datasets.errors import FileNotFound` | **Datasets** | FileNotFoundOnBranch | `from foundry_sdk.v2.datasets.errors import FileNotFoundOnBranch` | **Datasets** | FileNotFoundOnTransactionRange | `from foundry_sdk.v2.datasets.errors import FileNotFoundOnTransactionRange` | +**Datasets** | GetDatasetSchedulesPermissionDenied | `from foundry_sdk.v2.datasets.errors import GetDatasetSchedulesPermissionDenied` | **Datasets** | GetFileContentPermissionDenied | `from foundry_sdk.v2.datasets.errors import GetFileContentPermissionDenied` | **Datasets** | InvalidBranchName | `from foundry_sdk.v2.datasets.errors import InvalidBranchName` | **Datasets** | InvalidTransactionType | `from foundry_sdk.v2.datasets.errors import InvalidTransactionType` | diff --git a/changelog/@unreleased/pr-196.v2.yml b/changelog/@unreleased/pr-196.v2.yml new file mode 100644 index 000000000..cca4903ad --- /dev/null +++ b/changelog/@unreleased/pr-196.v2.yml @@ -0,0 +1,5 @@ +type: improvement +improvement: + description: Fix config error package name + links: + - https://github.com/palantir/foundry-platform-python/pull/196 diff --git a/config.json b/config.json index df51dc321..6e54af59b 100644 --- a/config.json +++ b/config.json @@ -26,16 +26,18 @@ "majorVersion": "v2", "operationName": "getDataset" }, - "packageName": "datasets", - "errorPackageName": "datasets", - "exampleError": "DatasetNotFound", - "exampleGenericError": "UnauthorizedError", - "exampleErrorMessage": "There was an error with the request", + "packageName": "foundry_sdk", + "errorPackageName": "foundry_sdk.v1.datasets.errors", + "exampleError": "BranchNotFound", + "exampleGenericError": "NotFoundError", + "exampleErrorMessage": "Resource not found", "errorTestParameters": { - "datasetRid": "ri.a.b.c.d" + "datasetRid": "ri.a.b.c.d", + "branchId": "main" }, "errorTest2Parameters": { - "datasetRid": 123 + "datasetRid": "ri.a.b.c.d", + "branchId": 123 } }, "paginationExampleOperation": { diff --git a/docs-snippets-npm/package.json b/docs-snippets-npm/package.json index c4f0eff91..817d48ec6 100644 --- a/docs-snippets-npm/package.json +++ b/docs-snippets-npm/package.json @@ -24,7 +24,7 @@ "sls": { "dependencies": { "com.palantir.foundry.api:api-gateway": { - "minVersion": "1.1149.0", + "minVersion": "1.1151.0", "maxVersion": "1.x.x", "optional": false } diff --git a/docs-snippets-npm/src/index.ts b/docs-snippets-npm/src/index.ts index 00253079d..a5d093249 100644 --- a/docs-snippets-npm/src/index.ts +++ b/docs-snippets-npm/src/index.ts @@ -623,6 +623,11 @@ export const PYTHON_PLATFORM_SNIPPETS: SdkSnippets str: value = os.environ.get(key) if value is None: - raise foundry_sdk.EnvironmentNotConfigured(f"Please set {key} using `export {key}=<{key}>`") + raise EnvironmentNotConfigured(f"Please set {key} using `export {key}=<{key}>`") return value @@ -43,9 +45,9 @@ def get_from_environ(key: str) -> str: @click.group() # type: ignore @click.pass_context # type: ignore def cli(ctx: _Context): - "An experimental CLI for the Foundry API" - ctx.obj = foundry_sdk.v1.FoundryClient( - auth=foundry_sdk.UserTokenAuth(token=get_from_environ("FOUNDRY_TOKEN")), + """An experimental CLI for the Foundry API""" + ctx.obj = FoundryClient( + auth=UserTokenAuth(token=get_from_environ("FOUNDRY_TOKEN")), hostname=get_from_environ("FOUNDRY_HOSTNAME"), ) @@ -70,7 +72,7 @@ def datasets_dataset(): @click.option("--parent_folder_rid", type=str, required=True, help="""""") @click.pass_obj def datasets_dataset_create( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, name: str, parent_folder_rid: str, ): @@ -106,7 +108,7 @@ def datasets_dataset_create( ) @click.pass_obj def datasets_dataset_delete_schema( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, dataset_rid: str, branch_id: typing.Optional[str], preview: typing.Optional[bool], @@ -129,7 +131,7 @@ def datasets_dataset_delete_schema( @click.argument("dataset_rid", type=str, required=True) @click.pass_obj def datasets_dataset_get( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, dataset_rid: str, ): """ @@ -163,7 +165,7 @@ def datasets_dataset_get( ) @click.pass_obj def datasets_dataset_get_schema( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, dataset_rid: str, branch_id: typing.Optional[str], preview: typing.Optional[bool], @@ -222,7 +224,7 @@ def datasets_dataset_get_schema( ) @click.pass_obj def datasets_dataset_read( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, dataset_rid: str, format: typing.Literal["ARROW", "CSV"], branch_id: typing.Optional[str], @@ -264,7 +266,7 @@ def datasets_dataset_read( @click.option("--preview", type=bool, required=False, help="""""") @click.pass_obj def datasets_dataset_replace_schema( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, dataset_rid: str, body: str, branch_id: typing.Optional[str], @@ -293,7 +295,7 @@ def datasets_dataset_transaction(): @click.argument("transaction_rid", type=str, required=True) @click.pass_obj def datasets_dataset_transaction_abort( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, dataset_rid: str, transaction_rid: str, ): @@ -316,7 +318,7 @@ def datasets_dataset_transaction_abort( @click.argument("transaction_rid", type=str, required=True) @click.pass_obj def datasets_dataset_transaction_commit( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, dataset_rid: str, transaction_rid: str, ): @@ -351,7 +353,7 @@ def datasets_dataset_transaction_commit( ) @click.pass_obj def datasets_dataset_transaction_create( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, dataset_rid: str, branch_id: typing.Optional[str], transaction_type: typing.Optional[typing.Literal["APPEND", "UPDATE", "SNAPSHOT", "DELETE"]], @@ -375,7 +377,7 @@ def datasets_dataset_transaction_create( @click.argument("transaction_rid", type=str, required=True) @click.pass_obj def datasets_dataset_transaction_get( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, dataset_rid: str, transaction_rid: str, ): @@ -414,7 +416,7 @@ def datasets_dataset_file(): ) @click.pass_obj def datasets_dataset_file_delete( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, dataset_rid: str, file_path: str, branch_id: typing.Optional[str], @@ -471,7 +473,7 @@ def datasets_dataset_file_delete( ) @click.pass_obj def datasets_dataset_file_get( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, dataset_rid: str, file_path: str, branch_id: typing.Optional[str], @@ -546,7 +548,7 @@ def datasets_dataset_file_get( ) @click.pass_obj def datasets_dataset_file_list( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, dataset_rid: str, branch_id: typing.Optional[str], end_transaction_rid: typing.Optional[str], @@ -617,7 +619,7 @@ def datasets_dataset_file_list( ) @click.pass_obj def datasets_dataset_file_read( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, dataset_rid: str, file_path: str, branch_id: typing.Optional[str], @@ -688,7 +690,7 @@ def datasets_dataset_file_read( ) @click.pass_obj def datasets_dataset_file_upload( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, dataset_rid: str, body: io.BufferedReader, file_path: str, @@ -741,7 +743,7 @@ def datasets_dataset_branch(): @click.option("--transaction_rid", type=str, required=False, help="""""") @click.pass_obj def datasets_dataset_branch_create( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, dataset_rid: str, branch_id: str, transaction_rid: typing.Optional[str], @@ -765,7 +767,7 @@ def datasets_dataset_branch_create( @click.argument("branch_id", type=str, required=True) @click.pass_obj def datasets_dataset_branch_delete( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, dataset_rid: str, branch_id: str, ): @@ -787,7 +789,7 @@ def datasets_dataset_branch_delete( @click.argument("branch_id", type=str, required=True) @click.pass_obj def datasets_dataset_branch_get( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, dataset_rid: str, branch_id: str, ): @@ -817,7 +819,7 @@ def datasets_dataset_branch_get( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def datasets_dataset_branch_list( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, dataset_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -857,7 +859,7 @@ def ontologies_query(): @click.option("--parameters", type=str, required=True, help="""""") @click.pass_obj def ontologies_query_execute( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, ontology_rid: str, query_api_name: str, parameters: str, @@ -889,7 +891,7 @@ def ontologies_ontology_object(): @click.option("--query", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_object_aggregate( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, ontology_rid: str, object_type: str, aggregation: str, @@ -926,7 +928,7 @@ def ontologies_ontology_object_aggregate( ) @click.pass_obj def ontologies_ontology_object_get( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, ontology_rid: str, object_type: str, primary_key: str, @@ -963,7 +965,7 @@ def ontologies_ontology_object_get( ) @click.pass_obj def ontologies_ontology_object_get_linked_object( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, ontology_rid: str, object_type: str, primary_key: str, @@ -1012,7 +1014,7 @@ def ontologies_ontology_object_get_linked_object( ) @click.pass_obj def ontologies_ontology_object_list( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, ontology_rid: str, object_type: str, order_by: typing.Optional[str], @@ -1077,7 +1079,7 @@ def ontologies_ontology_object_list( ) @click.pass_obj def ontologies_ontology_object_list_linked_objects( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, ontology_rid: str, object_type: str, primary_key: str, @@ -1137,7 +1139,7 @@ def ontologies_ontology_object_list_linked_objects( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_object_search( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, ontology_rid: str, object_type: str, fields: str, @@ -1194,7 +1196,7 @@ def ontologies_ontology(): @click.argument("ontology_rid", type=str, required=True) @click.pass_obj def ontologies_ontology_get( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, ontology_rid: str, ): """ @@ -1212,7 +1214,7 @@ def ontologies_ontology_get( @ontologies_ontology.command("list") @click.pass_obj def ontologies_ontology_list( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, ): """ Lists the Ontologies visible to the current user. @@ -1234,7 +1236,7 @@ def ontologies_ontology_query_type(): @click.argument("query_api_name", type=str, required=True) @click.pass_obj def ontologies_ontology_query_type_get( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, ontology_rid: str, query_api_name: str, ): @@ -1264,7 +1266,7 @@ def ontologies_ontology_query_type_get( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_query_type_list( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, ontology_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -1296,7 +1298,7 @@ def ontologies_ontology_object_type(): @click.argument("object_type", type=str, required=True) @click.pass_obj def ontologies_ontology_object_type_get( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, ontology_rid: str, object_type: str, ): @@ -1319,7 +1321,7 @@ def ontologies_ontology_object_type_get( @click.argument("link_type", type=str, required=True) @click.pass_obj def ontologies_ontology_object_type_get_outgoing_link_type( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, ontology_rid: str, object_type: str, link_type: str, @@ -1352,7 +1354,7 @@ def ontologies_ontology_object_type_get_outgoing_link_type( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_object_type_list( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, ontology_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -1384,7 +1386,7 @@ def ontologies_ontology_object_type_list( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_object_type_list_outgoing_link_types( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, ontology_rid: str, object_type: str, page_size: typing.Optional[int], @@ -1416,7 +1418,7 @@ def ontologies_ontology_action_type(): @click.argument("action_type_api_name", type=str, required=True) @click.pass_obj def ontologies_ontology_action_type_get( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, ontology_rid: str, action_type_api_name: str, ): @@ -1446,7 +1448,7 @@ def ontologies_ontology_action_type_get( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_action_type_list( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, ontology_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -1477,7 +1479,7 @@ def ontologies_attachment(): @click.argument("attachment_rid", type=str, required=True) @click.pass_obj def ontologies_attachment_get( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, attachment_rid: str, ): """ @@ -1497,7 +1499,7 @@ def ontologies_attachment_get( @click.argument("attachment_rid", type=str, required=True) @click.pass_obj def ontologies_attachment_read( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, attachment_rid: str, ): """ @@ -1529,7 +1531,7 @@ def ontologies_attachment_read( ) @click.pass_obj def ontologies_attachment_upload( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, body: io.BufferedReader, content_length: int, content_type: str, @@ -1566,7 +1568,7 @@ def ontologies_action(): @click.option("--parameters", type=str, required=True, help="""""") @click.pass_obj def ontologies_action_apply( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, ontology_rid: str, action_type: str, parameters: str, @@ -1598,7 +1600,7 @@ def ontologies_action_apply( @click.option("--requests", type=str, required=True, help="""""") @click.pass_obj def ontologies_action_apply_batch( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, ontology_rid: str, action_type: str, requests: str, @@ -1632,7 +1634,7 @@ def ontologies_action_apply_batch( @click.option("--parameters", type=str, required=True, help="""""") @click.pass_obj def ontologies_action_validate( - client: foundry_sdk.v1.FoundryClient, + client: FoundryClient, ontology_rid: str, action_type: str, parameters: str, diff --git a/foundry_sdk/v2/aip_agents/agent.py b/foundry_sdk/v2/aip_agents/agent.py index cd9f71635..72d39695f 100644 --- a/foundry_sdk/v2/aip_agents/agent.py +++ b/foundry_sdk/v2/aip_agents/agent.py @@ -96,6 +96,7 @@ def all_sessions( :return: Returns the result object. :rtype: core.ResourceIterator[aip_agents_models.Session] + :raises GetAllSessionsAgentsPermissionDenied: The calling user does not have permission to list all sessions across all Agents. Listing all sessions across all agents requires the `api:aip-agents-write` scope. :raises ListSessionsForAgentsPermissionDenied: Could not allSessions the Agent. """ @@ -117,6 +118,7 @@ def all_sessions( response_type=aip_agents_models.AgentsSessionsPage, request_timeout=request_timeout, throwable_errors={ + "GetAllSessionsAgentsPermissionDenied": aip_agents_errors.GetAllSessionsAgentsPermissionDenied, "ListSessionsForAgentsPermissionDenied": aip_agents_errors.ListSessionsForAgentsPermissionDenied, }, response_mode=_sdk_internal.get("response_mode", "ITERATOR"), diff --git a/foundry_sdk/v2/aip_agents/agent_version.py b/foundry_sdk/v2/aip_agents/agent_version.py index 04b125b54..fffd48a70 100644 --- a/foundry_sdk/v2/aip_agents/agent_version.py +++ b/foundry_sdk/v2/aip_agents/agent_version.py @@ -73,7 +73,10 @@ def get( :return: Returns the result object. :rtype: aip_agents_models.AgentVersion + :raises AgentNotFound: The given Agent could not be found. :raises AgentVersionNotFound: The given AgentVersion could not be found. + :raises InvalidAgentVersion: The provided version string is not a valid format for an Agent version. + :raises NoPublishedAgentVersion: Failed to retrieve the latest published version of the Agent because the Agent has no published versions. Try publishing the Agent in AIP Agent Studio to use the latest published version, or specify the version of the Agent to use. """ return self._api_client.call_api( @@ -95,7 +98,10 @@ def get( response_type=aip_agents_models.AgentVersion, request_timeout=request_timeout, throwable_errors={ + "AgentNotFound": aip_agents_errors.AgentNotFound, "AgentVersionNotFound": aip_agents_errors.AgentVersionNotFound, + "InvalidAgentVersion": aip_agents_errors.InvalidAgentVersion, + "NoPublishedAgentVersion": aip_agents_errors.NoPublishedAgentVersion, }, response_mode=_sdk_internal.get("response_mode"), ), @@ -130,6 +136,8 @@ def list( :type request_timeout: Optional[int] :return: Returns the result object. :rtype: core.ResourceIterator[aip_agents_models.AgentVersion] + + :raises AgentNotFound: The given Agent could not be found. """ return self._api_client.call_api( @@ -151,7 +159,9 @@ def list( body_type=None, response_type=aip_agents_models.ListAgentVersionsResponse, request_timeout=request_timeout, - throwable_errors={}, + throwable_errors={ + "AgentNotFound": aip_agents_errors.AgentNotFound, + }, response_mode=_sdk_internal.get("response_mode", "ITERATOR"), ), ) diff --git a/foundry_sdk/v2/aip_agents/content.py b/foundry_sdk/v2/aip_agents/content.py index 152c530da..e8ab46c02 100644 --- a/foundry_sdk/v2/aip_agents/content.py +++ b/foundry_sdk/v2/aip_agents/content.py @@ -73,7 +73,9 @@ def get( :return: Returns the result object. :rtype: aip_agents_models.Content + :raises AgentNotFound: The given Agent could not be found. :raises ContentNotFound: The given Content could not be found. + :raises SessionNotFound: The given Session could not be found. """ return self._api_client.call_api( @@ -95,7 +97,9 @@ def get( response_type=aip_agents_models.Content, request_timeout=request_timeout, throwable_errors={ + "AgentNotFound": aip_agents_errors.AgentNotFound, "ContentNotFound": aip_agents_errors.ContentNotFound, + "SessionNotFound": aip_agents_errors.SessionNotFound, }, response_mode=_sdk_internal.get("response_mode"), ), diff --git a/foundry_sdk/v2/aip_agents/session.py b/foundry_sdk/v2/aip_agents/session.py index e0886ab23..6a51299c4 100644 --- a/foundry_sdk/v2/aip_agents/session.py +++ b/foundry_sdk/v2/aip_agents/session.py @@ -273,11 +273,14 @@ def create( :rtype: aip_agents_models.Session :raises AgentNotFound: The given Agent could not be found. + :raises AgentVersionNotFound: The given AgentVersion could not be found. :raises CreateSessionPermissionDenied: Could not create the Session. :raises FunctionLocatorNotFound: The specified function locator is configured for use by the Agent but could not be found. The function type or version may not exist or the client token does not have access. + :raises InvalidAgentVersion: The provided version string is not a valid format for an Agent version. :raises NoPublishedAgentVersion: Failed to retrieve the latest published version of the Agent because the Agent has no published versions. Try publishing the Agent in AIP Agent Studio to use the latest published version, or specify the version of the Agent to use. :raises ObjectTypeIdsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). :raises ObjectTypeRidsNotFound: Some object types are configured for use by the Agent but could not be found. The object types either do not exist or the client token does not have access. Object types can be checked by listing available object types through the API, or searching in [Ontology Manager](https://palantir.com/docs/foundry/ontology-manager/overview/). + :raises SessionNotFound: The given Session could not be found. """ return self._api_client.call_api( @@ -307,11 +310,14 @@ def create( request_timeout=request_timeout, throwable_errors={ "AgentNotFound": aip_agents_errors.AgentNotFound, + "AgentVersionNotFound": aip_agents_errors.AgentVersionNotFound, "CreateSessionPermissionDenied": aip_agents_errors.CreateSessionPermissionDenied, "FunctionLocatorNotFound": aip_agents_errors.FunctionLocatorNotFound, + "InvalidAgentVersion": aip_agents_errors.InvalidAgentVersion, "NoPublishedAgentVersion": aip_agents_errors.NoPublishedAgentVersion, "ObjectTypeIdsNotFound": aip_agents_errors.ObjectTypeIdsNotFound, "ObjectTypeRidsNotFound": aip_agents_errors.ObjectTypeRidsNotFound, + "SessionNotFound": aip_agents_errors.SessionNotFound, }, response_mode=_sdk_internal.get("response_mode"), ), @@ -342,6 +348,7 @@ def get( :return: Returns the result object. :rtype: aip_agents_models.Session + :raises AgentNotFound: The given Agent could not be found. :raises SessionNotFound: The given Session could not be found. """ @@ -364,6 +371,7 @@ def get( response_type=aip_agents_models.Session, request_timeout=request_timeout, throwable_errors={ + "AgentNotFound": aip_agents_errors.AgentNotFound, "SessionNotFound": aip_agents_errors.SessionNotFound, }, response_mode=_sdk_internal.get("response_mode"), diff --git a/foundry_sdk/v2/cli.py b/foundry_sdk/v2/cli.py index 786eb7bac..0f1098a00 100644 --- a/foundry_sdk/v2/cli.py +++ b/foundry_sdk/v2/cli.py @@ -24,18 +24,20 @@ import click -import foundry_sdk.v2 +from foundry_sdk import EnvironmentNotConfigured +from foundry_sdk import UserTokenAuth +from foundry_sdk.v2 import FoundryClient @dataclasses.dataclass class _Context: - obj: foundry_sdk.v2.FoundryClient + obj: FoundryClient def get_from_environ(key: str) -> str: value = os.environ.get(key) if value is None: - raise foundry_sdk.EnvironmentNotConfigured(f"Please set {key} using `export {key}=<{key}>`") + raise EnvironmentNotConfigured(f"Please set {key} using `export {key}=<{key}>`") return value @@ -43,9 +45,9 @@ def get_from_environ(key: str) -> str: @click.group() # type: ignore @click.pass_context # type: ignore def cli(ctx: _Context): - "An experimental CLI for the Foundry API" - ctx.obj = foundry_sdk.v2.FoundryClient( - auth=foundry_sdk.UserTokenAuth(token=get_from_environ("FOUNDRY_TOKEN")), + """An experimental CLI for the Foundry API""" + ctx.obj = FoundryClient( + auth=UserTokenAuth(token=get_from_environ("FOUNDRY_TOKEN")), hostname=get_from_environ("FOUNDRY_HOSTNAME"), ) @@ -64,7 +66,7 @@ def admin_user(): @click.argument("user_id", type=str, required=True) @click.pass_obj def admin_user_delete( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, user_id: str, ): """ @@ -80,7 +82,7 @@ def admin_user_delete( @click.argument("user_id", type=str, required=True) @click.pass_obj def admin_user_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, user_id: str, ): """ @@ -96,7 +98,7 @@ def admin_user_get( @click.argument("body", type=str, required=True) @click.pass_obj def admin_user_get_batch( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, body: str, ): """ @@ -113,7 +115,7 @@ def admin_user_get_batch( @admin_user.command("get_current") @click.pass_obj def admin_user_get_current( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ): """ """ result = client.admin.User.get_current() @@ -127,7 +129,7 @@ def admin_user_get_current( ) @click.pass_obj def admin_user_get_markings( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, user_id: str, preview: typing.Optional[bool], ): @@ -155,7 +157,7 @@ def admin_user_get_markings( ) @click.pass_obj def admin_user_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, page_size: typing.Optional[int], page_token: typing.Optional[str], ): @@ -175,7 +177,7 @@ def admin_user_list( @click.argument("user_id", type=str, required=True) @click.pass_obj def admin_user_profile_picture( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, user_id: str, ): """ """ @@ -191,7 +193,7 @@ def admin_user_profile_picture( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def admin_user_search( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, where: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -240,7 +242,7 @@ def admin_user_group_membership(): ) @click.pass_obj def admin_user_group_membership_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, user_id: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -277,7 +279,7 @@ def admin_user_user_provider_info(): ) @click.pass_obj def admin_user_user_provider_info_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, user_id: str, preview: typing.Optional[bool], ): @@ -306,7 +308,7 @@ def admin_user_user_provider_info_get( ) @click.pass_obj def admin_user_user_provider_info_replace( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, user_id: str, provider_id: str, preview: typing.Optional[bool], @@ -334,7 +336,7 @@ def admin_organization(): ) @click.pass_obj def admin_organization_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, organization_rid: str, preview: typing.Optional[bool], ): @@ -365,7 +367,7 @@ def admin_organization_get( ) @click.pass_obj def admin_organization_replace( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, organization_rid: str, name: str, description: typing.Optional[str], @@ -397,7 +399,7 @@ def admin_marking_category(): ) @click.pass_obj def admin_marking_category_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, marking_category_id: str, preview: typing.Optional[bool], ): @@ -428,7 +430,7 @@ def admin_marking_category_get( ) @click.pass_obj def admin_marking_category_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, page_size: typing.Optional[int], page_token: typing.Optional[str], preview: typing.Optional[bool], @@ -476,7 +478,7 @@ def admin_marking(): ) @click.pass_obj def admin_marking_create( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, category_id: str, initial_members: str, initial_role_assignments: str, @@ -505,7 +507,7 @@ def admin_marking_create( ) @click.pass_obj def admin_marking_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, marking_id: str, preview: typing.Optional[bool], ): @@ -526,7 +528,7 @@ def admin_marking_get( ) @click.pass_obj def admin_marking_get_batch( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, body: str, preview: typing.Optional[bool], ): @@ -559,7 +561,7 @@ def admin_marking_get_batch( ) @click.pass_obj def admin_marking_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, page_size: typing.Optional[int], page_token: typing.Optional[str], preview: typing.Optional[bool], @@ -588,7 +590,7 @@ def admin_marking_marking_role_assignment(): ) @click.pass_obj def admin_marking_marking_role_assignment_add( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, marking_id: str, role_assignments: str, preview: typing.Optional[bool], @@ -620,7 +622,7 @@ def admin_marking_marking_role_assignment_add( ) @click.pass_obj def admin_marking_marking_role_assignment_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, marking_id: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -647,7 +649,7 @@ def admin_marking_marking_role_assignment_list( ) @click.pass_obj def admin_marking_marking_role_assignment_remove( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, marking_id: str, role_assignments: str, preview: typing.Optional[bool], @@ -674,7 +676,7 @@ def admin_marking_marking_member(): ) @click.pass_obj def admin_marking_marking_member_add( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, marking_id: str, principal_ids: str, preview: typing.Optional[bool], @@ -718,7 +720,7 @@ def admin_marking_marking_member_add( ) @click.pass_obj def admin_marking_marking_member_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, marking_id: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -748,7 +750,7 @@ def admin_marking_marking_member_list( ) @click.pass_obj def admin_marking_marking_member_remove( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, marking_id: str, principal_ids: str, preview: typing.Optional[bool], @@ -785,7 +787,7 @@ def admin_group(): @click.option("--description", type=str, required=False, help="""A description of the Group.""") @click.pass_obj def admin_group_create( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, attributes: str, name: str, organizations: str, @@ -807,7 +809,7 @@ def admin_group_create( @click.argument("group_id", type=str, required=True) @click.pass_obj def admin_group_delete( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, group_id: str, ): """ @@ -823,7 +825,7 @@ def admin_group_delete( @click.argument("group_id", type=str, required=True) @click.pass_obj def admin_group_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, group_id: str, ): """ @@ -839,7 +841,7 @@ def admin_group_get( @click.argument("body", type=str, required=True) @click.pass_obj def admin_group_get_batch( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, body: str, ): """ @@ -867,7 +869,7 @@ def admin_group_get_batch( ) @click.pass_obj def admin_group_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, page_size: typing.Optional[int], page_token: typing.Optional[str], ): @@ -889,7 +891,7 @@ def admin_group_list( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def admin_group_search( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, where: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -917,7 +919,7 @@ def admin_group_group_member(): @click.option("--expiration", type=click.DateTime(), required=False, help="""""") @click.pass_obj def admin_group_group_member_add( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, group_id: str, principal_ids: str, expiration: typing.Optional[datetime], @@ -958,7 +960,7 @@ def admin_group_group_member_add( ) @click.pass_obj def admin_group_group_member_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, group_id: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -988,7 +990,7 @@ def admin_group_group_member_list( @click.option("--principal_ids", type=str, required=True, help="""""") @click.pass_obj def admin_group_group_member_remove( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, group_id: str, principal_ids: str, ): @@ -1012,7 +1014,7 @@ def admin_group_group_provider_info(): ) @click.pass_obj def admin_group_group_provider_info_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, group_id: str, preview: typing.Optional[bool], ): @@ -1041,7 +1043,7 @@ def admin_group_group_provider_info_get( ) @click.pass_obj def admin_group_group_provider_info_replace( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, group_id: str, provider_id: str, preview: typing.Optional[bool], @@ -1069,7 +1071,7 @@ def admin_enrollment(): ) @click.pass_obj def admin_enrollment_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, enrollment_rid: str, preview: typing.Optional[bool], ): @@ -1089,7 +1091,7 @@ def admin_enrollment_get( ) @click.pass_obj def admin_enrollment_get_current( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, preview: typing.Optional[bool], ): """ @@ -1115,7 +1117,7 @@ def admin_enrollment_authentication_provider(): ) @click.pass_obj def admin_enrollment_authentication_provider_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, enrollment_rid: str, authentication_provider_rid: str, preview: typing.Optional[bool], @@ -1138,7 +1140,7 @@ def admin_enrollment_authentication_provider_get( ) @click.pass_obj def admin_enrollment_authentication_provider_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, enrollment_rid: str, preview: typing.Optional[bool], ): @@ -1170,7 +1172,7 @@ def admin_enrollment_authentication_provider_list( ) @click.pass_obj def admin_enrollment_authentication_provider_preregister_group( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, enrollment_rid: str, authentication_provider_rid: str, name: str, @@ -1218,7 +1220,7 @@ def admin_enrollment_authentication_provider_preregister_group( ) @click.pass_obj def admin_enrollment_authentication_provider_preregister_user( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, enrollment_rid: str, authentication_provider_rid: str, organization: str, @@ -1271,7 +1273,7 @@ def admin_enrollment_host(): ) @click.pass_obj def admin_enrollment_host_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, enrollment_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -1316,7 +1318,7 @@ def aip_agents_agent(): ) @click.pass_obj def aip_agents_agent_all_sessions( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, page_size: typing.Optional[int], page_token: typing.Optional[str], preview: typing.Optional[bool], @@ -1348,7 +1350,7 @@ def aip_agents_agent_all_sessions( ) @click.pass_obj def aip_agents_agent_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, agent_rid: str, preview: typing.Optional[bool], version: typing.Optional[str], @@ -1398,7 +1400,7 @@ def aip_agents_agent_session(): ) @click.pass_obj def aip_agents_agent_session_blocking_continue( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, agent_rid: str, session_rid: str, parameter_inputs: str, @@ -1450,7 +1452,7 @@ def aip_agents_agent_session_blocking_continue( ) @click.pass_obj def aip_agents_agent_session_cancel( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, agent_rid: str, session_rid: str, message_id: str, @@ -1489,7 +1491,7 @@ def aip_agents_agent_session_cancel( ) @click.pass_obj def aip_agents_agent_session_create( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, agent_rid: str, agent_version: typing.Optional[str], preview: typing.Optional[bool], @@ -1515,7 +1517,7 @@ def aip_agents_agent_session_create( ) @click.pass_obj def aip_agents_agent_session_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, agent_rid: str, session_rid: str, preview: typing.Optional[bool], @@ -1549,7 +1551,7 @@ def aip_agents_agent_session_get( ) @click.pass_obj def aip_agents_agent_session_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, agent_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -1592,7 +1594,7 @@ def aip_agents_agent_session_list( ) @click.pass_obj def aip_agents_agent_session_rag_context( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, agent_rid: str, session_rid: str, parameter_inputs: str, @@ -1650,7 +1652,7 @@ def aip_agents_agent_session_rag_context( ) @click.pass_obj def aip_agents_agent_session_streaming_continue( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, agent_rid: str, session_rid: str, parameter_inputs: str, @@ -1697,7 +1699,7 @@ def aip_agents_agent_session_streaming_continue( ) @click.pass_obj def aip_agents_agent_session_update_title( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, agent_rid: str, session_rid: str, title: str, @@ -1730,7 +1732,7 @@ def aip_agents_agent_session_content(): ) @click.pass_obj def aip_agents_agent_session_content_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, agent_rid: str, session_rid: str, preview: typing.Optional[bool], @@ -1759,7 +1761,7 @@ def aip_agents_agent_agent_version(): ) @click.pass_obj def aip_agents_agent_agent_version_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, agent_rid: str, agent_version_string: str, preview: typing.Optional[bool], @@ -1793,7 +1795,7 @@ def aip_agents_agent_agent_version_get( ) @click.pass_obj def aip_agents_agent_agent_version_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, agent_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -1837,7 +1839,7 @@ def connectivity_connection(): ) @click.pass_obj def connectivity_connection_create( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, configuration: str, display_name: str, parent_folder_rid: str, @@ -1871,7 +1873,7 @@ def connectivity_connection_create( ) @click.pass_obj def connectivity_connection_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, connection_rid: str, preview: typing.Optional[bool], ): @@ -1892,7 +1894,7 @@ def connectivity_connection_get( ) @click.pass_obj def connectivity_connection_get_configuration( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, connection_rid: str, preview: typing.Optional[bool], ): @@ -1922,7 +1924,7 @@ def connectivity_connection_get_configuration( ) @click.pass_obj def connectivity_connection_update_secrets( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, connection_rid: str, secrets: str, preview: typing.Optional[bool], @@ -1979,7 +1981,7 @@ def connectivity_connection_table_import(): ) @click.pass_obj def connectivity_connection_table_import_create( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, connection_rid: str, config: str, dataset_rid: str, @@ -2013,7 +2015,7 @@ def connectivity_connection_table_import_create( ) @click.pass_obj def connectivity_connection_table_import_delete( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, connection_rid: str, table_import_rid: str, preview: typing.Optional[bool], @@ -2040,7 +2042,7 @@ def connectivity_connection_table_import_delete( ) @click.pass_obj def connectivity_connection_table_import_execute( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, connection_rid: str, table_import_rid: str, preview: typing.Optional[bool], @@ -2066,7 +2068,7 @@ def connectivity_connection_table_import_execute( ) @click.pass_obj def connectivity_connection_table_import_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, connection_rid: str, table_import_rid: str, preview: typing.Optional[bool], @@ -2100,7 +2102,7 @@ def connectivity_connection_table_import_get( ) @click.pass_obj def connectivity_connection_table_import_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, connection_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -2146,7 +2148,7 @@ def connectivity_connection_table_import_list( ) @click.pass_obj def connectivity_connection_table_import_replace( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, connection_rid: str, table_import_rid: str, config: str, @@ -2209,7 +2211,7 @@ def connectivity_connection_file_import(): ) @click.pass_obj def connectivity_connection_file_import_create( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, connection_rid: str, dataset_rid: str, display_name: str, @@ -2243,7 +2245,7 @@ def connectivity_connection_file_import_create( ) @click.pass_obj def connectivity_connection_file_import_delete( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, connection_rid: str, file_import_rid: str, preview: typing.Optional[bool], @@ -2270,7 +2272,7 @@ def connectivity_connection_file_import_delete( ) @click.pass_obj def connectivity_connection_file_import_execute( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, connection_rid: str, file_import_rid: str, preview: typing.Optional[bool], @@ -2296,7 +2298,7 @@ def connectivity_connection_file_import_execute( ) @click.pass_obj def connectivity_connection_file_import_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, connection_rid: str, file_import_rid: str, preview: typing.Optional[bool], @@ -2330,7 +2332,7 @@ def connectivity_connection_file_import_get( ) @click.pass_obj def connectivity_connection_file_import_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, connection_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -2381,7 +2383,7 @@ def connectivity_connection_file_import_list( ) @click.pass_obj def connectivity_connection_file_import_replace( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, connection_rid: str, file_import_rid: str, dataset_rid: str, @@ -2429,7 +2431,7 @@ def datasets_dataset(): @click.option("--parent_folder_rid", type=str, required=True, help="""""") @click.pass_obj def datasets_dataset_create( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, name: str, parent_folder_rid: str, ): @@ -2448,7 +2450,7 @@ def datasets_dataset_create( @click.argument("dataset_rid", type=str, required=True) @click.pass_obj def datasets_dataset_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, dataset_rid: str, ): """ @@ -2460,6 +2462,43 @@ def datasets_dataset_get( click.echo(repr(result)) +@datasets_dataset.command("get_schedules") +@click.argument("dataset_rid", type=str, required=True) +@click.option( + "--branch_name", + type=str, + required=False, + help="""The name of the Branch. If none is provided, the default Branch name - `master` for most enrollments - will be used. +""", +) +@click.option("--page_size", type=int, required=False, help="""""") +@click.option("--page_token", type=str, required=False, help="""""") +@click.option( + "--preview", type=bool, required=False, help="""Enables the use of preview functionality.""" +) +@click.pass_obj +def datasets_dataset_get_schedules( + client: FoundryClient, + dataset_rid: str, + branch_name: typing.Optional[str], + page_size: typing.Optional[int], + page_token: typing.Optional[str], + preview: typing.Optional[bool], +): + """ + Get the RIDs of the Schedules that target the given Dataset + + """ + result = client.datasets.Dataset.get_schedules( + dataset_rid=dataset_rid, + branch_name=branch_name, + page_size=page_size, + page_token=page_token, + preview=preview, + ) + click.echo(repr(result)) + + @datasets_dataset.command("read_table") @click.argument("dataset_rid", type=str, required=True) @click.option( @@ -2506,7 +2545,7 @@ def datasets_dataset_get( ) @click.pass_obj def datasets_dataset_read_table( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, dataset_rid: str, format: typing.Literal["ARROW", "CSV"], branch_name: typing.Optional[str], @@ -2564,7 +2603,7 @@ def datasets_dataset_file(): ) @click.pass_obj def datasets_dataset_file_content( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, dataset_rid: str, file_path: str, branch_name: typing.Optional[str], @@ -2620,7 +2659,7 @@ def datasets_dataset_file_content( ) @click.pass_obj def datasets_dataset_file_delete( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, dataset_rid: str, file_path: str, branch_name: typing.Optional[str], @@ -2674,7 +2713,7 @@ def datasets_dataset_file_delete( ) @click.pass_obj def datasets_dataset_file_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, dataset_rid: str, file_path: str, branch_name: typing.Optional[str], @@ -2746,7 +2785,7 @@ def datasets_dataset_file_get( ) @click.pass_obj def datasets_dataset_file_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, dataset_rid: str, branch_name: typing.Optional[str], end_transaction_rid: typing.Optional[str], @@ -2813,7 +2852,7 @@ def datasets_dataset_file_list( ) @click.pass_obj def datasets_dataset_file_upload( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, dataset_rid: str, file_path: str, body: io.BufferedReader, @@ -2858,7 +2897,7 @@ def datasets_dataset_transaction(): @click.argument("transaction_rid", type=str, required=True) @click.pass_obj def datasets_dataset_transaction_abort( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, dataset_rid: str, transaction_rid: str, ): @@ -2882,7 +2921,7 @@ def datasets_dataset_transaction_abort( ) @click.pass_obj def datasets_dataset_transaction_build( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, dataset_rid: str, transaction_rid: str, preview: typing.Optional[bool], @@ -2906,7 +2945,7 @@ def datasets_dataset_transaction_build( @click.argument("transaction_rid", type=str, required=True) @click.pass_obj def datasets_dataset_transaction_commit( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, dataset_rid: str, transaction_rid: str, ): @@ -2939,7 +2978,7 @@ def datasets_dataset_transaction_commit( ) @click.pass_obj def datasets_dataset_transaction_create( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, dataset_rid: str, transaction_type: typing.Literal["APPEND", "UPDATE", "SNAPSHOT", "DELETE"], branch_name: typing.Optional[str], @@ -2961,7 +3000,7 @@ def datasets_dataset_transaction_create( @click.argument("transaction_rid", type=str, required=True) @click.pass_obj def datasets_dataset_transaction_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, dataset_rid: str, transaction_rid: str, ): @@ -2984,7 +3023,7 @@ def datasets_dataset_transaction_get( ) @click.pass_obj def datasets_dataset_transaction_job( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, dataset_rid: str, transaction_rid: str, preview: typing.Optional[bool], @@ -3019,7 +3058,7 @@ def datasets_dataset_branch(): ) @click.pass_obj def datasets_dataset_branch_create( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, dataset_rid: str, name: str, transaction_rid: typing.Optional[str], @@ -3041,7 +3080,7 @@ def datasets_dataset_branch_create( @click.argument("branch_name", type=str, required=True) @click.pass_obj def datasets_dataset_branch_delete( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, dataset_rid: str, branch_name: str, ): @@ -3061,7 +3100,7 @@ def datasets_dataset_branch_delete( @click.argument("branch_name", type=str, required=True) @click.pass_obj def datasets_dataset_branch_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, dataset_rid: str, branch_name: str, ): @@ -3091,7 +3130,7 @@ def datasets_dataset_branch_get( ) @click.pass_obj def datasets_dataset_branch_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, dataset_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -3135,7 +3174,7 @@ def filesystem_space(): ) @click.pass_obj def filesystem_space_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, page_size: typing.Optional[int], page_token: typing.Optional[str], preview: typing.Optional[bool], @@ -3166,7 +3205,7 @@ def filesystem_resource(): ) @click.pass_obj def filesystem_resource_add_markings( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, resource_rid: str, marking_ids: str, preview: typing.Optional[bool], @@ -3189,7 +3228,7 @@ def filesystem_resource_add_markings( ) @click.pass_obj def filesystem_resource_delete( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, resource_rid: str, preview: typing.Optional[bool], ): @@ -3212,7 +3251,7 @@ def filesystem_resource_delete( ) @click.pass_obj def filesystem_resource_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, resource_rid: str, preview: typing.Optional[bool], ): @@ -3233,7 +3272,7 @@ def filesystem_resource_get( ) @click.pass_obj def filesystem_resource_get_access_requirements( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, resource_rid: str, preview: typing.Optional[bool], ): @@ -3261,7 +3300,7 @@ def filesystem_resource_get_access_requirements( ) @click.pass_obj def filesystem_resource_get_by_path( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, path: str, preview: typing.Optional[bool], ): @@ -3293,7 +3332,7 @@ def filesystem_resource_get_by_path( ) @click.pass_obj def filesystem_resource_markings( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, resource_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -3320,7 +3359,7 @@ def filesystem_resource_markings( ) @click.pass_obj def filesystem_resource_permanently_delete( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, resource_rid: str, preview: typing.Optional[bool], ): @@ -3344,7 +3383,7 @@ def filesystem_resource_permanently_delete( ) @click.pass_obj def filesystem_resource_remove_markings( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, resource_rid: str, marking_ids: str, preview: typing.Optional[bool], @@ -3367,7 +3406,7 @@ def filesystem_resource_remove_markings( ) @click.pass_obj def filesystem_resource_restore( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, resource_rid: str, preview: typing.Optional[bool], ): @@ -3396,7 +3435,7 @@ def filesystem_resource_resource_role(): ) @click.pass_obj def filesystem_resource_resource_role_add( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, resource_rid: str, roles: str, preview: typing.Optional[bool], @@ -3434,7 +3473,7 @@ def filesystem_resource_resource_role_add( ) @click.pass_obj def filesystem_resource_resource_role_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, resource_rid: str, include_inherited: typing.Optional[bool], page_size: typing.Optional[int], @@ -3463,7 +3502,7 @@ def filesystem_resource_resource_role_list( ) @click.pass_obj def filesystem_resource_resource_role_remove( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, resource_rid: str, roles: str, preview: typing.Optional[bool], @@ -3490,7 +3529,7 @@ def filesystem_project(): ) @click.pass_obj def filesystem_project_add_organizations( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, project_rid: str, organization_rids: str, preview: typing.Optional[bool], @@ -3518,7 +3557,7 @@ def filesystem_project_add_organizations( ) @click.pass_obj def filesystem_project_create( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, default_roles: str, display_name: str, organization_rids: str, @@ -3558,7 +3597,7 @@ def filesystem_project_create( @click.option("--project_description", type=str, required=False, help="""""") @click.pass_obj def filesystem_project_create_from_template( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, template_rid: str, variable_values: str, default_roles: typing.Optional[str], @@ -3587,7 +3626,7 @@ def filesystem_project_create_from_template( ) @click.pass_obj def filesystem_project_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, project_rid: str, preview: typing.Optional[bool], ): @@ -3619,7 +3658,7 @@ def filesystem_project_get( ) @click.pass_obj def filesystem_project_organizations( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, project_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -3647,7 +3686,7 @@ def filesystem_project_organizations( ) @click.pass_obj def filesystem_project_remove_organizations( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, project_rid: str, organization_rids: str, preview: typing.Optional[bool], @@ -3686,7 +3725,7 @@ def filesystem_folder(): ) @click.pass_obj def filesystem_folder_children( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, folder_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -3723,7 +3762,7 @@ def filesystem_folder_children( ) @click.pass_obj def filesystem_folder_create( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, display_name: str, parent_folder_rid: str, preview: typing.Optional[bool], @@ -3746,7 +3785,7 @@ def filesystem_folder_create( ) @click.pass_obj def filesystem_folder_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, folder_rid: str, preview: typing.Optional[bool], ): @@ -3777,7 +3816,7 @@ def functions_value_type(): ) @click.pass_obj def functions_value_type_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, value_type_rid: str, preview: typing.Optional[bool], ): @@ -3805,7 +3844,7 @@ def functions_value_type_version_id(): ) @click.pass_obj def functions_value_type_version_id_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, value_type_rid: str, version_id_version_id: str, preview: typing.Optional[bool], @@ -3836,7 +3875,7 @@ def functions_query(): @click.option("--version", type=str, required=False, help="""""") @click.pass_obj def functions_query_execute( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, query_api_name: str, parameters: str, preview: typing.Optional[bool], @@ -3865,7 +3904,7 @@ def functions_query_execute( @click.option("--version", type=str, required=False, help="""""") @click.pass_obj def functions_query_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, query_api_name: str, preview: typing.Optional[bool], version: typing.Optional[str], @@ -3890,7 +3929,7 @@ def functions_query_get( @click.option("--version", type=str, required=False, help="""""") @click.pass_obj def functions_query_get_by_rid( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, rid: str, preview: typing.Optional[bool], version: typing.Optional[str], @@ -3934,7 +3973,7 @@ def media_sets_media_set(): ) @click.pass_obj def media_sets_media_set_abort( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, media_set_rid: str, transaction_id: str, preview: typing.Optional[bool], @@ -3965,7 +4004,7 @@ def media_sets_media_set_abort( ) @click.pass_obj def media_sets_media_set_commit( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, media_set_rid: str, transaction_id: str, preview: typing.Optional[bool], @@ -4002,7 +4041,7 @@ def media_sets_media_set_commit( ) @click.pass_obj def media_sets_media_set_create( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, media_set_rid: str, branch_name: typing.Optional[str], preview: typing.Optional[bool], @@ -4034,7 +4073,7 @@ def media_sets_media_set_create( @click.option("--read_token", type=str, required=False, help="""""") @click.pass_obj def media_sets_media_set_info( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, media_set_rid: str, media_item_rid: str, preview: typing.Optional[bool], @@ -4068,7 +4107,7 @@ def media_sets_media_set_info( @click.option("--read_token", type=str, required=False, help="""""") @click.pass_obj def media_sets_media_set_read( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, media_set_rid: str, media_item_rid: str, preview: typing.Optional[bool], @@ -4102,7 +4141,7 @@ def media_sets_media_set_read( @click.option("--read_token", type=str, required=False, help="""""") @click.pass_obj def media_sets_media_set_read_original( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, media_set_rid: str, media_item_rid: str, preview: typing.Optional[bool], @@ -4136,7 +4175,7 @@ def media_sets_media_set_read_original( @click.option("--read_token", type=str, required=False, help="""""") @click.pass_obj def media_sets_media_set_reference( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, media_set_rid: str, media_item_rid: str, preview: typing.Optional[bool], @@ -4200,7 +4239,7 @@ def media_sets_media_set_reference( ) @click.pass_obj def media_sets_media_set_upload( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, media_set_rid: str, body: io.BufferedReader, branch_name: typing.Optional[str], @@ -4262,7 +4301,7 @@ def ontologies_time_series_value_bank_property(): ) @click.pass_obj def ontologies_time_series_value_bank_property_get_latest_value( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -4310,7 +4349,7 @@ def ontologies_time_series_value_bank_property_get_latest_value( @click.option("--range", type=str, required=False, help="""""") @click.pass_obj def ontologies_time_series_value_bank_property_stream_values( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -4364,7 +4403,7 @@ def ontologies_time_series_property_v2(): ) @click.pass_obj def ontologies_time_series_property_v2_get_first_point( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -4411,7 +4450,7 @@ def ontologies_time_series_property_v2_get_first_point( ) @click.pass_obj def ontologies_time_series_property_v2_get_last_point( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -4468,7 +4507,7 @@ def ontologies_time_series_property_v2_get_last_point( @click.option("--range", type=str, required=False, help="""""") @click.pass_obj def ontologies_time_series_property_v2_stream_points( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -4532,7 +4571,7 @@ def ontologies_query(): ) @click.pass_obj def ontologies_query_execute( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, query_api_name: str, parameters: str, @@ -4592,7 +4631,7 @@ def ontologies_ontology_object_set(): ) @click.pass_obj def ontologies_ontology_object_set_aggregate( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, aggregation: str, group_by: str, @@ -4624,7 +4663,7 @@ def ontologies_ontology_object_set_aggregate( @click.option("--object_set", type=str, required=True, help="""""") @click.pass_obj def ontologies_ontology_object_set_create_temporary( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_set: str, ): @@ -4647,7 +4686,7 @@ def ontologies_ontology_object_set_create_temporary( @click.argument("object_set_rid", type=str, required=True) @click.pass_obj def ontologies_ontology_object_set_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_set_rid: str, ): @@ -4695,7 +4734,7 @@ def ontologies_ontology_object_set_get( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_object_set_load( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_set: str, select: str, @@ -4771,7 +4810,7 @@ def ontologies_ontology_object_set_load( ) @click.pass_obj def ontologies_ontology_object_set_load_multiple_object_types( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_set: str, select: str, @@ -4854,7 +4893,7 @@ def ontologies_ontology_object_set_load_multiple_object_types( ) @click.pass_obj def ontologies_ontology_object_set_load_objects_or_interfaces( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_set: str, select: str, @@ -4934,7 +4973,7 @@ def ontologies_ontology_object(): @click.option("--where", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_object_aggregate( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, aggregation: str, @@ -4982,7 +5021,7 @@ def ontologies_ontology_object_aggregate( ) @click.pass_obj def ontologies_ontology_object_count( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, artifact_repository: typing.Optional[str], @@ -5039,7 +5078,7 @@ def ontologies_ontology_object_count( ) @click.pass_obj def ontologies_ontology_object_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -5111,7 +5150,7 @@ def ontologies_ontology_object_get( ) @click.pass_obj def ontologies_ontology_object_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, artifact_repository: typing.Optional[str], @@ -5192,7 +5231,7 @@ def ontologies_ontology_object_list( @click.option("--where", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_object_search( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, select: str, @@ -5220,11 +5259,11 @@ def ontologies_ontology_object_search( | not | The sub-query does not match. | N/A (applied on a query) | | and | All the sub-queries match. | N/A (applied on queries) | | or | At least one of the sub-queries match. | N/A (applied on queries) | - | startsWith | The provided property starts with the provided term. | string | | containsAllTermsInOrderPrefixLastTerm | The provided property contains all the terms provided in order. The last term can be a partial prefix match. | string | | containsAllTermsInOrder | The provided property contains the provided term as a substring. | string | | containsAnyTerm | The provided property contains at least one of the terms separated by whitespace. | string | | containsAllTerms | The provided property contains all the terms separated by whitespace. | string | + | startsWith | Deprecated alias for containsAllTermsInOrderPrefixLastTerm. | string | Queries can be at most three levels deep. By default, terms are separated by whitespace or punctuation (`?!,:;-[](){}'"~`). Periods (`.`) on their own are ignored. Partial terms are not matched by terms filters except where explicitly noted. @@ -5273,7 +5312,7 @@ def ontologies_ontology_interface(): @click.option("--where", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_interface_aggregate( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, interface_type: str, aggregation: str, @@ -5322,7 +5361,7 @@ def ontologies_ontology_interface_aggregate( ) @click.pass_obj def ontologies_ontology_interface_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, interface_type: str, preview: typing.Optional[bool], @@ -5366,7 +5405,7 @@ def ontologies_ontology_interface_get( ) @click.pass_obj def ontologies_ontology_interface_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -5454,7 +5493,7 @@ def ontologies_ontology_interface_list( @click.option("--where", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_interface_search( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, interface_type: str, augmented_properties: str, @@ -5533,7 +5572,7 @@ def ontologies_ontology(): @click.argument("ontology", type=str, required=True) @click.pass_obj def ontologies_ontology_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, ): """ @@ -5552,7 +5591,7 @@ def ontologies_ontology_get( @click.argument("ontology", type=str, required=True) @click.pass_obj def ontologies_ontology_get_full_metadata( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, ): """ @@ -5568,7 +5607,7 @@ def ontologies_ontology_get_full_metadata( @ontologies_ontology.command("list") @click.pass_obj def ontologies_ontology_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ): """ Lists the Ontologies visible to the current user. @@ -5589,7 +5628,7 @@ def ontologies_ontology_list( @click.option("--query_types", type=str, required=True, help="""""") @click.pass_obj def ontologies_ontology_load_metadata( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, action_types: str, interface_types: str, @@ -5629,7 +5668,7 @@ def ontologies_ontology_query_type(): ) @click.pass_obj def ontologies_ontology_query_type_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, query_api_name: str, version: typing.Optional[str], @@ -5661,7 +5700,7 @@ def ontologies_ontology_query_type_get( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_query_type_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -5693,7 +5732,7 @@ def ontologies_ontology_object_type(): @click.argument("object_type", type=str, required=True) @click.pass_obj def ontologies_ontology_object_type_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, ): @@ -5722,7 +5761,7 @@ def ontologies_ontology_object_type_get( ) @click.pass_obj def ontologies_ontology_object_type_get_full_metadata( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, preview: typing.Optional[bool], @@ -5747,7 +5786,7 @@ def ontologies_ontology_object_type_get_full_metadata( @click.argument("link_type", type=str, required=True) @click.pass_obj def ontologies_ontology_object_type_get_outgoing_link_type( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, link_type: str, @@ -5780,7 +5819,7 @@ def ontologies_ontology_object_type_get_outgoing_link_type( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_object_type_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -5812,7 +5851,7 @@ def ontologies_ontology_object_type_list( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_object_type_list_outgoing_link_types( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, page_size: typing.Optional[int], @@ -5844,7 +5883,7 @@ def ontologies_ontology_action_type(): @click.argument("action_type", type=str, required=True) @click.pass_obj def ontologies_ontology_action_type_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, action_type: str, ): @@ -5866,7 +5905,7 @@ def ontologies_ontology_action_type_get( @click.argument("action_type_rid", type=str, required=True) @click.pass_obj def ontologies_ontology_action_type_get_by_rid( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, action_type_rid: str, ): @@ -5896,7 +5935,7 @@ def ontologies_ontology_action_type_get_by_rid( @click.option("--page_token", type=str, required=False, help="""""") @click.pass_obj def ontologies_ontology_action_type_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -5951,7 +5990,7 @@ def ontologies_media_reference_property(): ) @click.pass_obj def ontologies_media_reference_property_get_media_content( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -6006,7 +6045,7 @@ def ontologies_media_reference_property_get_media_content( ) @click.pass_obj def ontologies_media_reference_property_get_media_metadata( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -6054,7 +6093,7 @@ def ontologies_media_reference_property_get_media_metadata( ) @click.pass_obj def ontologies_media_reference_property_upload( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, property: str, @@ -6123,7 +6162,7 @@ def ontologies_linked_object(): ) @click.pass_obj def ontologies_linked_object_get_linked_object( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -6203,7 +6242,7 @@ def ontologies_linked_object_get_linked_object( ) @click.pass_obj def ontologies_linked_object_list_linked_objects( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -6262,7 +6301,7 @@ def ontologies_cipher_text_property(): @click.argument("property", type=str, required=True) @click.pass_obj def ontologies_cipher_text_property_decrypt( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -6310,7 +6349,7 @@ def ontologies_attachment_property(): ) @click.pass_obj def ontologies_attachment_property_get_attachment( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -6358,7 +6397,7 @@ def ontologies_attachment_property_get_attachment( ) @click.pass_obj def ontologies_attachment_property_get_attachment_by_rid( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -6407,7 +6446,7 @@ def ontologies_attachment_property_get_attachment_by_rid( ) @click.pass_obj def ontologies_attachment_property_read_attachment( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -6455,7 +6494,7 @@ def ontologies_attachment_property_read_attachment( ) @click.pass_obj def ontologies_attachment_property_read_attachment_by_rid( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, object_type: str, primary_key: str, @@ -6494,7 +6533,7 @@ def ontologies_attachment(): @click.argument("attachment_rid", type=str, required=True) @click.pass_obj def ontologies_attachment_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, attachment_rid: str, ): """ @@ -6514,7 +6553,7 @@ def ontologies_attachment_get( @click.argument("attachment_rid", type=str, required=True) @click.pass_obj def ontologies_attachment_read( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, attachment_rid: str, ): """ @@ -6546,7 +6585,7 @@ def ontologies_attachment_read( ) @click.pass_obj def ontologies_attachment_upload( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, body: io.BufferedReader, content_length: int, content_type: str, @@ -6598,7 +6637,7 @@ def ontologies_action(): ) @click.pass_obj def ontologies_action_apply( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, action: str, parameters: str, @@ -6651,7 +6690,7 @@ def ontologies_action_apply( ) @click.pass_obj def ontologies_action_apply_batch( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, ontology: str, action: str, requests: str, @@ -6702,7 +6741,7 @@ def orchestration_schedule_version(): ) @click.pass_obj def orchestration_schedule_version_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, schedule_version_rid: str, preview: typing.Optional[bool], ): @@ -6723,7 +6762,7 @@ def orchestration_schedule_version_get( ) @click.pass_obj def orchestration_schedule_version_schedule( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, schedule_version_rid: str, preview: typing.Optional[bool], ): @@ -6758,7 +6797,7 @@ def orchestration_schedule(): ) @click.pass_obj def orchestration_schedule_create( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, action: str, description: typing.Optional[str], display_name: typing.Optional[str], @@ -6787,7 +6826,7 @@ def orchestration_schedule_create( ) @click.pass_obj def orchestration_schedule_delete( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, schedule_rid: str, preview: typing.Optional[bool], ): @@ -6808,7 +6847,7 @@ def orchestration_schedule_delete( ) @click.pass_obj def orchestration_schedule_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, schedule_rid: str, preview: typing.Optional[bool], ): @@ -6829,7 +6868,7 @@ def orchestration_schedule_get( ) @click.pass_obj def orchestration_schedule_pause( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, schedule_rid: str, preview: typing.Optional[bool], ): @@ -6860,7 +6899,7 @@ def orchestration_schedule_pause( ) @click.pass_obj def orchestration_schedule_replace( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, schedule_rid: str, action: str, description: typing.Optional[str], @@ -6891,7 +6930,7 @@ def orchestration_schedule_replace( ) @click.pass_obj def orchestration_schedule_run( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, schedule_rid: str, preview: typing.Optional[bool], ): @@ -6921,7 +6960,7 @@ def orchestration_schedule_run( ) @click.pass_obj def orchestration_schedule_runs( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, schedule_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -6947,7 +6986,7 @@ def orchestration_schedule_runs( ) @click.pass_obj def orchestration_schedule_unpause( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, schedule_rid: str, preview: typing.Optional[bool], ): @@ -6971,7 +7010,7 @@ def orchestration_job(): ) @click.pass_obj def orchestration_job_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, job_rid: str, preview: typing.Optional[bool], ): @@ -6992,7 +7031,7 @@ def orchestration_job_get( ) @click.pass_obj def orchestration_job_get_batch( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, body: str, preview: typing.Optional[bool], ): @@ -7017,7 +7056,7 @@ def orchestration_build(): @click.argument("build_rid", type=str, required=True) @click.pass_obj def orchestration_build_cancel( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, build_rid: str, ): """ @@ -7054,7 +7093,7 @@ def orchestration_build_cancel( ) @click.pass_obj def orchestration_build_create( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, fallback_branches: str, target: str, abort_on_failure: typing.Optional[bool], @@ -7084,7 +7123,7 @@ def orchestration_build_create( @click.argument("build_rid", type=str, required=True) @click.pass_obj def orchestration_build_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, build_rid: str, ): """ @@ -7100,7 +7139,7 @@ def orchestration_build_get( @click.argument("body", type=str, required=True) @click.pass_obj def orchestration_build_get_batch( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, body: str, ): """ @@ -7132,7 +7171,7 @@ def orchestration_build_get_batch( ) @click.pass_obj def orchestration_build_jobs( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, build_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -7166,7 +7205,7 @@ def orchestration_build_jobs( ) @click.pass_obj def orchestration_build_search( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, where: str, order_by: typing.Optional[str], page_size: typing.Optional[int], @@ -7203,7 +7242,7 @@ def sql_queries_sql_query(): ) @click.pass_obj def sql_queries_sql_query_cancel( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, sql_query_id: str, preview: typing.Optional[bool], ): @@ -7243,7 +7282,7 @@ def sql_queries_sql_query_cancel( ) @click.pass_obj def sql_queries_sql_query_execute( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, query: str, fallback_branch_ids: typing.Optional[str], preview: typing.Optional[bool], @@ -7269,7 +7308,7 @@ def sql_queries_sql_query_execute( ) @click.pass_obj def sql_queries_sql_query_get_results( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, sql_query_id: str, preview: typing.Optional[bool], ): @@ -7292,7 +7331,7 @@ def sql_queries_sql_query_get_results( ) @click.pass_obj def sql_queries_sql_query_get_status( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, sql_query_id: str, preview: typing.Optional[bool], ): @@ -7369,7 +7408,7 @@ def streams_dataset(): ) @click.pass_obj def streams_dataset_create( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, name: str, parent_folder_rid: str, schema: str, @@ -7437,7 +7476,7 @@ def streams_dataset_stream(): ) @click.pass_obj def streams_dataset_stream_create( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, dataset_rid: str, branch_name: str, schema: str, @@ -7470,7 +7509,7 @@ def streams_dataset_stream_create( ) @click.pass_obj def streams_dataset_stream_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, dataset_rid: str, stream_branch_name: str, preview: typing.Optional[bool], @@ -7508,7 +7547,7 @@ def streams_dataset_stream_get( ) @click.pass_obj def streams_dataset_stream_publish_binary_record( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, dataset_rid: str, stream_branch_name: str, body: io.BufferedReader, @@ -7555,7 +7594,7 @@ def streams_dataset_stream_publish_binary_record( ) @click.pass_obj def streams_dataset_stream_publish_record( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, dataset_rid: str, stream_branch_name: str, record: str, @@ -7603,7 +7642,7 @@ def streams_dataset_stream_publish_record( ) @click.pass_obj def streams_dataset_stream_publish_records( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, dataset_rid: str, stream_branch_name: str, records: str, @@ -7672,7 +7711,7 @@ def streams_dataset_stream_publish_records( ) @click.pass_obj def streams_dataset_stream_reset( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, dataset_rid: str, stream_branch_name: str, compressed: typing.Optional[bool], @@ -7720,7 +7759,7 @@ def third_party_applications_third_party_application(): ) @click.pass_obj def third_party_applications_third_party_application_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, third_party_application_rid: str, preview: typing.Optional[bool], ): @@ -7744,7 +7783,7 @@ def third_party_applications_third_party_application_website(): @click.option("--version", type=str, required=True, help="""""") @click.pass_obj def third_party_applications_third_party_application_website_deploy( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, third_party_application_rid: str, version: str, ): @@ -7762,7 +7801,7 @@ def third_party_applications_third_party_application_website_deploy( @click.argument("third_party_application_rid", type=str, required=True) @click.pass_obj def third_party_applications_third_party_application_website_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, third_party_application_rid: str, ): """ @@ -7778,7 +7817,7 @@ def third_party_applications_third_party_application_website_get( @click.argument("third_party_application_rid", type=str, required=True) @click.pass_obj def third_party_applications_third_party_application_website_undeploy( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, third_party_application_rid: str, ): """ @@ -7800,7 +7839,7 @@ def third_party_applications_third_party_application_website_version(): @click.argument("version_version", type=str, required=True) @click.pass_obj def third_party_applications_third_party_application_website_version_delete( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, third_party_application_rid: str, version_version: str, ): @@ -7819,7 +7858,7 @@ def third_party_applications_third_party_application_website_version_delete( @click.argument("version_version", type=str, required=True) @click.pass_obj def third_party_applications_third_party_application_website_version_get( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, third_party_application_rid: str, version_version: str, ): @@ -7848,7 +7887,7 @@ def third_party_applications_third_party_application_website_version_get( ) @click.pass_obj def third_party_applications_third_party_application_website_version_list( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, third_party_application_rid: str, page_size: typing.Optional[int], page_token: typing.Optional[str], @@ -7872,7 +7911,7 @@ def third_party_applications_third_party_application_website_version_list( @click.option("--version", type=str, required=True, help="""""") @click.pass_obj def third_party_applications_third_party_application_website_version_upload( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, third_party_application_rid: str, body: io.BufferedReader, version: str, @@ -7906,7 +7945,7 @@ def third_party_applications_third_party_application_website_version_upload( ) @click.pass_obj def third_party_applications_third_party_application_website_version_upload_snapshot( - client: foundry_sdk.v2.FoundryClient, + client: FoundryClient, third_party_application_rid: str, body: io.BufferedReader, version: str, diff --git a/foundry_sdk/v2/core/models.py b/foundry_sdk/v2/core/models.py index 1e25dcfd2..73ec7b4af 100644 --- a/foundry_sdk/v2/core/models.py +++ b/foundry_sdk/v2/core/models.py @@ -780,6 +780,10 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: """ +ScheduleRid = core.RID +"""The RID of a Schedule.""" + + class ShortType(pydantic.BaseModel): """ShortType""" @@ -1067,6 +1071,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: "Reference", "ReleaseStatus", "RoleId", + "ScheduleRid", "ShortType", "SizeBytes", "StreamSchema", diff --git a/foundry_sdk/v2/datasets/dataset.py b/foundry_sdk/v2/datasets/dataset.py index e17b011c4..5204257c9 100644 --- a/foundry_sdk/v2/datasets/dataset.py +++ b/foundry_sdk/v2/datasets/dataset.py @@ -21,6 +21,7 @@ from foundry_sdk import _core as core from foundry_sdk import _errors as errors +from foundry_sdk.v2.core import models as core_models from foundry_sdk.v2.datasets import errors as datasets_errors from foundry_sdk.v2.datasets import models as datasets_models from foundry_sdk.v2.filesystem import errors as filesystem_errors @@ -182,6 +183,68 @@ def get( ), ) + @core.maybe_ignore_preview + @pydantic.validate_call + @errors.handle_unexpected + def get_schedules( + self, + dataset_rid: datasets_models.DatasetRid, + *, + branch_name: typing.Optional[datasets_models.BranchName] = None, + page_size: typing.Optional[core_models.PageSize] = None, + page_token: typing.Optional[core_models.PageToken] = None, + preview: typing.Optional[core_models.PreviewMode] = None, + request_timeout: typing.Optional[core.Timeout] = None, + _sdk_internal: core.SdkInternal = {}, + ) -> core.ResourceIterator[core_models.ScheduleRid]: + """ + Get the RIDs of the Schedules that target the given Dataset + + :param dataset_rid: + :type dataset_rid: DatasetRid + :param branch_name: The name of the Branch. If none is provided, the default Branch name - `master` for most enrollments - will be used. + :type branch_name: Optional[BranchName] + :param page_size: + :type page_size: Optional[PageSize] + :param page_token: + :type page_token: Optional[PageToken] + :param preview: Enables the use of preview functionality. + :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: core.ResourceIterator[core_models.ScheduleRid] + + :raises GetDatasetSchedulesPermissionDenied: Could not getSchedules the Dataset. + """ + + return self._api_client.call_api( + core.RequestInfo( + method="GET", + resource_path="/v2/datasets/{datasetRid}/getSchedules", + query_params={ + "branchName": branch_name, + "pageSize": page_size, + "pageToken": page_token, + "preview": preview, + }, + path_params={ + "datasetRid": dataset_rid, + }, + header_params={ + "Accept": "application/json", + }, + body=None, + body_type=None, + response_type=datasets_models.ListSchedulesResponse, + request_timeout=request_timeout, + throwable_errors={ + "GetDatasetSchedulesPermissionDenied": datasets_errors.GetDatasetSchedulesPermissionDenied, + }, + response_mode=_sdk_internal.get("response_mode", "ITERATOR"), + ), + ) + @core.maybe_ignore_preview @pydantic.validate_call @errors.handle_unexpected @@ -269,10 +332,12 @@ class _DatasetClientRaw: def __init__(self, client: DatasetClient) -> None: def create(_: datasets_models.Dataset): ... def get(_: datasets_models.Dataset): ... + def get_schedules(_: datasets_models.ListSchedulesResponse): ... def read_table(_: bytes): ... self.create = core.with_raw_response(create, client.create) self.get = core.with_raw_response(get, client.get) + self.get_schedules = core.with_raw_response(get_schedules, client.get_schedules) self.read_table = core.with_raw_response(read_table, client.read_table) @@ -280,8 +345,10 @@ class _DatasetClientStreaming: def __init__(self, client: DatasetClient) -> None: def create(_: datasets_models.Dataset): ... def get(_: datasets_models.Dataset): ... + def get_schedules(_: datasets_models.ListSchedulesResponse): ... def read_table(_: bytes): ... self.create = core.with_streaming_response(create, client.create) self.get = core.with_streaming_response(get, client.get) + self.get_schedules = core.with_streaming_response(get_schedules, client.get_schedules) self.read_table = core.with_streaming_response(read_table, client.read_table) diff --git a/foundry_sdk/v2/datasets/errors.py b/foundry_sdk/v2/datasets/errors.py index b3cc184cb..d4d674d9a 100644 --- a/foundry_sdk/v2/datasets/errors.py +++ b/foundry_sdk/v2/datasets/errors.py @@ -314,6 +314,21 @@ class FileNotFoundOnTransactionRange(errors.NotFoundError): error_instance_id: str +class GetDatasetSchedulesPermissionDeniedParameters(typing_extensions.TypedDict): + """Could not getSchedules the Dataset.""" + + __pydantic_config__ = {"extra": "allow"} # type: ignore + + datasetRid: datasets_models.DatasetRid + + +@dataclass +class GetDatasetSchedulesPermissionDenied(errors.PermissionDeniedError): + name: typing.Literal["GetDatasetSchedulesPermissionDenied"] + parameters: GetDatasetSchedulesPermissionDeniedParameters + error_instance_id: str + + class GetFileContentPermissionDeniedParameters(typing_extensions.TypedDict): """Could not content the File.""" @@ -577,6 +592,7 @@ class UploadFilePermissionDenied(errors.PermissionDeniedError): "FileNotFound", "FileNotFoundOnBranch", "FileNotFoundOnTransactionRange", + "GetDatasetSchedulesPermissionDenied", "GetFileContentPermissionDenied", "InvalidBranchName", "InvalidTransactionType", diff --git a/foundry_sdk/v2/datasets/models.py b/foundry_sdk/v2/datasets/models.py index c4ee944dd..3d73fa843 100644 --- a/foundry_sdk/v2/datasets/models.py +++ b/foundry_sdk/v2/datasets/models.py @@ -105,6 +105,18 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: return self.model_dump(by_alias=True, exclude_none=True) +class ListSchedulesResponse(pydantic.BaseModel): + """ListSchedulesResponse""" + + data: typing.List[core_models.ScheduleRid] + next_page_token: typing.Optional[core_models.PageToken] = pydantic.Field(alias=str("nextPageToken"), default=None) # type: ignore[literal-required] + model_config = {"extra": "allow", "populate_by_name": True} + + def to_dict(self) -> typing.Dict[str, typing.Any]: + """Return the dictionary representation of the model using the field aliases.""" + return self.model_dump(by_alias=True, exclude_none=True) + + TableExportFormat = typing.Literal["ARROW", "CSV"] """Format for tabular dataset export.""" @@ -154,6 +166,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: "FileUpdatedTime", "ListBranchesResponse", "ListFilesResponse", + "ListSchedulesResponse", "TableExportFormat", "Transaction", "TransactionCreatedTime", diff --git a/foundry_sdk/v2/ontologies/models.py b/foundry_sdk/v2/ontologies/models.py index 00b73b9db..d8bfe1171 100644 --- a/foundry_sdk/v2/ontologies/models.py +++ b/foundry_sdk/v2/ontologies/models.py @@ -3282,6 +3282,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: class StartsWithQuery(pydantic.BaseModel): """ + Deprecated alias for `containsAllTermsInOrderPrefixLastTerm`, which is preferred because the name `startsWith` is misleading. Returns objects where the specified field starts with the provided value. Allows you to specify a property to query on by a variety of means. Either `field` or `propertyIdentifier` must be supplied, but not both. """ diff --git a/foundry_sdk/v2/ontologies/ontology_object.py b/foundry_sdk/v2/ontologies/ontology_object.py index 14e9346a9..604afccff 100644 --- a/foundry_sdk/v2/ontologies/ontology_object.py +++ b/foundry_sdk/v2/ontologies/ontology_object.py @@ -376,11 +376,11 @@ def search( | not | The sub-query does not match. | N/A (applied on a query) | | and | All the sub-queries match. | N/A (applied on queries) | | or | At least one of the sub-queries match. | N/A (applied on queries) | - | startsWith | The provided property starts with the provided term. | string | | containsAllTermsInOrderPrefixLastTerm | The provided property contains all the terms provided in order. The last term can be a partial prefix match. | string | | containsAllTermsInOrder | The provided property contains the provided term as a substring. | string | | containsAnyTerm | The provided property contains at least one of the terms separated by whitespace. | string | | containsAllTerms | The provided property contains all the terms separated by whitespace. | string | + | startsWith | Deprecated alias for containsAllTermsInOrderPrefixLastTerm. | string | Queries can be at most three levels deep. By default, terms are separated by whitespace or punctuation (`?!,:;-[](){}'"~`). Periods (`.`) on their own are ignored. Partial terms are not matched by terms filters except where explicitly noted. diff --git a/foundry_sdk/v2/orchestration/errors.py b/foundry_sdk/v2/orchestration/errors.py index 197e870c0..e5d74032b 100644 --- a/foundry_sdk/v2/orchestration/errors.py +++ b/foundry_sdk/v2/orchestration/errors.py @@ -191,7 +191,7 @@ class DeleteSchedulePermissionDeniedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore - scheduleRid: orchestration_models.ScheduleRid + scheduleRid: core_models.ScheduleRid @dataclass @@ -343,7 +343,7 @@ class PauseSchedulePermissionDeniedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore - scheduleRid: orchestration_models.ScheduleRid + scheduleRid: core_models.ScheduleRid @dataclass @@ -358,7 +358,7 @@ class ReplaceSchedulePermissionDeniedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore - scheduleRid: orchestration_models.ScheduleRid + scheduleRid: core_models.ScheduleRid @dataclass @@ -373,7 +373,7 @@ class RunSchedulePermissionDeniedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore - scheduleRid: orchestration_models.ScheduleRid + scheduleRid: core_models.ScheduleRid @dataclass @@ -388,7 +388,7 @@ class ScheduleNotFoundParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore - scheduleRid: orchestration_models.ScheduleRid + scheduleRid: core_models.ScheduleRid @dataclass @@ -465,7 +465,7 @@ class TargetNotSupportedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore - scheduleRid: orchestration_models.ScheduleRid + scheduleRid: core_models.ScheduleRid @dataclass @@ -480,7 +480,7 @@ class UnpauseSchedulePermissionDeniedParameters(typing_extensions.TypedDict): __pydantic_config__ = {"extra": "allow"} # type: ignore - scheduleRid: orchestration_models.ScheduleRid + scheduleRid: core_models.ScheduleRid @dataclass diff --git a/foundry_sdk/v2/orchestration/models.py b/foundry_sdk/v2/orchestration/models.py index 803f5da9e..626cc6836 100644 --- a/foundry_sdk/v2/orchestration/models.py +++ b/foundry_sdk/v2/orchestration/models.py @@ -620,7 +620,7 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: class Schedule(pydantic.BaseModel): """Schedule""" - rid: ScheduleRid + rid: core_models.ScheduleRid display_name: typing.Optional[str] = pydantic.Field(alias=str("displayName"), default=None) # type: ignore[literal-required] description: typing.Optional[str] = None current_version_rid: ScheduleVersionRid = pydantic.Field(alias=str("currentVersionRid")) # type: ignore[literal-required] @@ -650,17 +650,13 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: """SchedulePaused""" -ScheduleRid = core.RID -"""The Resource Identifier (RID) of a Schedule.""" - - class ScheduleRun(pydantic.BaseModel): """ScheduleRun""" rid: ScheduleRunRid """The RID of a schedule run""" - schedule_rid: ScheduleRid = pydantic.Field(alias=str("scheduleRid")) # type: ignore[literal-required] + schedule_rid: core_models.ScheduleRid = pydantic.Field(alias=str("scheduleRid")) # type: ignore[literal-required] schedule_version_rid: ScheduleVersionRid = pydantic.Field(alias=str("scheduleVersionRid")) # type: ignore[literal-required] created_time: core_models.CreatedTime = pydantic.Field(alias=str("createdTime")) # type: ignore[literal-required] """The time at which the schedule run was created.""" @@ -752,7 +748,7 @@ class ScheduleSucceededTrigger(pydantic.BaseModel): successfully. """ - schedule_rid: ScheduleRid = pydantic.Field(alias=str("scheduleRid")) # type: ignore[literal-required] + schedule_rid: core_models.ScheduleRid = pydantic.Field(alias=str("scheduleRid")) # type: ignore[literal-required] type: typing.Literal["scheduleSucceeded"] = "scheduleSucceeded" model_config = {"extra": "allow", "populate_by_name": True} @@ -767,7 +763,7 @@ class ScheduleVersion(pydantic.BaseModel): rid: ScheduleVersionRid """The RID of a schedule version""" - schedule_rid: ScheduleRid = pydantic.Field(alias=str("scheduleRid")) # type: ignore[literal-required] + schedule_rid: core_models.ScheduleRid = pydantic.Field(alias=str("scheduleRid")) # type: ignore[literal-required] created_time: core_models.CreatedTime = pydantic.Field(alias=str("createdTime")) # type: ignore[literal-required] """The time the schedule version was created""" @@ -1082,7 +1078,6 @@ def to_dict(self) -> typing.Dict[str, typing.Any]: "RetryCount", "Schedule", "SchedulePaused", - "ScheduleRid", "ScheduleRun", "ScheduleRunError", "ScheduleRunErrorName", diff --git a/foundry_sdk/v2/orchestration/schedule.py b/foundry_sdk/v2/orchestration/schedule.py index 4d77d12dd..1a5a5aa05 100644 --- a/foundry_sdk/v2/orchestration/schedule.py +++ b/foundry_sdk/v2/orchestration/schedule.py @@ -130,7 +130,7 @@ def create( @errors.handle_unexpected def delete( self, - schedule_rid: orchestration_models.ScheduleRid, + schedule_rid: core_models.ScheduleRid, *, preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, @@ -177,7 +177,7 @@ def delete( @errors.handle_unexpected def get( self, - schedule_rid: orchestration_models.ScheduleRid, + schedule_rid: core_models.ScheduleRid, *, preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, @@ -226,7 +226,7 @@ def get( @errors.handle_unexpected def pause( self, - schedule_rid: orchestration_models.ScheduleRid, + schedule_rid: core_models.ScheduleRid, *, preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, @@ -273,7 +273,7 @@ def pause( @errors.handle_unexpected def replace( self, - schedule_rid: orchestration_models.ScheduleRid, + schedule_rid: core_models.ScheduleRid, *, action: orchestration_models.ReplaceScheduleRequestAction, description: typing.Optional[str] = None, @@ -355,7 +355,7 @@ def replace( @errors.handle_unexpected def run( self, - schedule_rid: orchestration_models.ScheduleRid, + schedule_rid: core_models.ScheduleRid, *, preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, @@ -404,7 +404,7 @@ def run( @errors.handle_unexpected def runs( self, - schedule_rid: orchestration_models.ScheduleRid, + schedule_rid: core_models.ScheduleRid, *, page_size: typing.Optional[core_models.PageSize] = None, page_token: typing.Optional[core_models.PageToken] = None, @@ -458,7 +458,7 @@ def runs( @errors.handle_unexpected def unpause( self, - schedule_rid: orchestration_models.ScheduleRid, + schedule_rid: core_models.ScheduleRid, *, preview: typing.Optional[core_models.PreviewMode] = None, request_timeout: typing.Optional[core.Timeout] = None, diff --git a/tests/test_errors.py b/tests/test_errors.py index f244833ac..8862c5152 100644 --- a/tests/test_errors.py +++ b/tests/test_errors.py @@ -4,24 +4,26 @@ from foundry_sdk import PalantirRPCException from foundry_sdk._errors.utils import deserialize_error -from foundry_sdk.v1.datasets.errors import AbortTransactionPermissionDenied from foundry_sdk.v1.datasets.errors import BranchNotFound + +class MockError(PalantirRPCException): + def __init__(self, name): + super().__init__(name) + + ERRORS_MAP = { - "AbortTransactionPermissionDenied": AbortTransactionPermissionDenied, + "MockError": MockError, "BranchNotFound": BranchNotFound, } -def test_correctly_deserializes_to_branch_not_found(): +def test_correctly_deserializes_error(): error = deserialize_error( { "errorName": "BranchNotFound", "errorInstanceId": "123", - "parameters": { - "datasetRid": "ri.a.b.c.d", - "branchId": "main", - }, + "parameters": {"datasetRid": "ri.a.b.c.d", "branchId": "main"}, }, ERRORS_MAP, ) @@ -30,8 +32,7 @@ def test_correctly_deserializes_to_branch_not_found(): assert isinstance(error, BranchNotFound) assert error.name == "BranchNotFound" assert error.error_instance_id == "123" - assert error.parameters["datasetRid"] == "ri.a.b.c.d" - assert error.parameters["branchId"] == "main" + assert error.parameters == {"datasetRid": "ri.a.b.c.d", "branchId": "main"} def test_falls_back_to_standard_if_parsing_fails(): @@ -40,15 +41,9 @@ def test_falls_back_to_standard_if_parsing_fails(): { "errorName": "BranchNotFound", "errorInstanceId": "123", - "parameters": { - "datasetRid": "ri.a.b.c.d", - "branchId": 123, - }, - }, - { - "AbortTransactionPermissionDenied": AbortTransactionPermissionDenied, - "BranchNotFound": BranchNotFound, + "parameters": {"datasetRid": "ri.a.b.c.d", "branchId": 123}, }, + ERRORS_MAP, ) assert len(w) == 1