ai_api_client_sdk.resource_clients.configuration_client module

class ai_api_client_sdk.resource_clients.configuration_client.ConfigurationClient(rest_client: RestClient)

Bases: BaseClient

ConfigurationClient is a class implemented for interacting with the configuration related endpoints of the server. It implements the base class ai_api_client_sdk.resource_clients.base_client.BaseClient

create(name: str, scenario_id: str, executable_id: str, parameter_bindings: List[ParameterBinding] = None, input_artifact_bindings: List[InputArtifactBinding] = None, resource_group: str = None) → ConfigurationCreateResponse

Creates a configuration.

Parameters:

  • name (str) – Name of the configuration

  • scenario_id (str) – ID of the scenario which the configuration should belong to

  • executable_id (str) – ID of the executable, which should be configured

  • parameter_bindings (List[class:ai_api_client_sdk.models.parameter_binding.ParameterBinding], optional) – List of the input parameters, defaults to None

  • input_artifact_bindings (List[class:ai_api_client_sdk.models.input_artifact_binding.InputArtifactBinding], optional) – List of the input artifacts which are to be used by the executable, defaults to None

  • resource_group (str) – Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.configuration_create_response.ConfigurationCreateResponse

get(configuration_id: str, expand: str = None, resource_group: str = None) → Configuration

Retrieves the configuration from the server.

Parameters:

  • configuration_id (str) – ID of the configuration to be retrieved

  • expand (str, optional) – Entity whose details to be displayed in the response, defaults to None

  • resource_group (str) – Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPINotFoundException if a 404 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

The retrieved configuration

Return type:

class:ai_api_client_sdk.models.configuration.Configuration

query(scenario_id: str = None, executable_ids: List[str] = None, top: int = None, skip: int = None, search: str = None, search_case_insensitive: bool = None, expand: str = None, resource_group: str = None) → ConfigurationQueryResponse

Queries the configurations.

Parameters:

  • scenario_id (str, optional) – ID of the scenario the configurations should belong to, defaults to None

  • executable_ids (List[str], optional) – IDs of the executables the configurations should have configured, defaults to None

  • top (int, optional) – Number of configurations to be retrieved, defaults to None

  • skip (int, optional) – Number of configurations to be skipped, from the list of the queried configurations, defaults to None

  • search (str, optional) – Generic search term to be looked for in various attributes of configurations, defaults to None

  • search_case_insensitive (bool, optional) – Indicates whether the search should be case insensitive

  • expand (str, optional) – Entity whose details to be displayed in the response, defaults to None

  • resource_group (str) – Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

class:ai_api_client_sdk.models.configuration_query_response.ConfigurationQueryResponse

count(scenario_id: str = None, executable_ids: List[str] = None, search: str = None, resource_group: str = None) → int

Counts the configurations.

Parameters:

  • scenario_id (str, optional) – ID of the scenario the configurations should belong to, defaults to None

  • executable_ids (List[str], optional) – IDs of the executables the configurations should have configured, defaults to None

  • search (str, optional) – Generic search term to be looked for in various attributes of configurations, defaults to None

  • resource_group (str) – Resource Group which the request should be sent on behalf. Either this or a default resource group in the ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client should be specified, defaults to None

Raises:

class:ai_api_client_sdk.exception.AIAPIInvalidRequestException if a 400 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIAuthorizationException if a 401 response is received from the server

Raises:

class:ai_api_client_sdk.exception.AIAPIServerException if a non-2XX response is received from the server

Returns:

An object representing the response from the server

Return type:

int