|
- Method resolution order:
- ConfigurationClient
- ai_api_client_sdk.resource_clients.base_client.BaseClient
- builtins.object
Methods defined here:
- count(self, scenario_id: str = None, executable_ids: List[str] = None, search: str = None, resource_group: str = None) -> int
- Counts the configurations.
:param scenario_id: ID of the scenario the configurations should belong to, defaults to None
:type scenario_id: str, optional
:param executable_ids: IDs of the executables the configurations should have configured, defaults to None
:type executable_ids: List[str], optional
:param search: Generic search term to be looked for in various attributes of configurations, defaults to None
:type search: str, optional
:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
defaults to None
:type resource_group: str
: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
:raises: class:`ai_api_client_sdk.exception.AIAPIRequestException` if an unexpected exception occurs while
trying to send a request to the server
:return: An object representing the response from the server
:rtype: int
- create(self, name: str, scenario_id: str, executable_id: str, parameter_bindings: List[ai_api_client_sdk.models.parameter_binding.ParameterBinding] = None, input_artifact_bindings: List[ai_api_client_sdk.models.input_artifact_binding.InputArtifactBinding] = None, resource_group: str = None) -> ai_api_client_sdk.models.configuration_create_response.ConfigurationCreateResponse
- Creates a configuration.
:param name: Name of the configuration
:type name: str
:param scenario_id: ID of the scenario which the configuration should belong to
:type scenario_id: str
:param executable_id: ID of the executable, which should be configured
:type executable_id: str
:param parameter_bindings: List of the input parameters, defaults to None
:type parameter_bindings: List[class:`ai_api_client_sdk.models.parameter_binding.ParameterBinding`], optional
:param input_artifact_bindings: List of the input artifacts which are to be used by the executable,
defaults to None
:type input_artifact_bindings:
List[class:`ai_api_client_sdk.models.input_artifact_binding.InputArtifactBinding`], optional
:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
defaults to None
:type resource_group: str
: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
:raises: class:`ai_api_client_sdk.exception.AIAPIRequestException` if an unexpected exception occurs while
trying to send a request to the server
:return: An object representing the response from the server
:rtype: class:`ai_api_client_sdk.models.configuration_create_response.ConfigurationCreateResponse`
- get(self, configuration_id: str, expand: str = None, resource_group: str = None) -> ai_api_client_sdk.models.configuration.Configuration
- Retrieves the configuration from the server.
:param configuration_id: ID of the configuration to be retrieved
:type configuration_id: str
:param expand: Entity whose details to be displayed in the response, defaults to None
:type expand: str, optional
:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
defaults to None
:type resource_group: str
: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
:raises: class:`ai_api_client_sdk.exception.AIAPIRequestException` if an unexpected exception occurs while
trying to send a request to the server
:return: The retrieved configuration
:rtype: class:`ai_api_client_sdk.models.configuration.Configuration`
- query(self, 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) -> ai_api_client_sdk.models.configuration_query_response.ConfigurationQueryResponse
- Queries the configurations.
:param scenario_id: ID of the scenario the configurations should belong to, defaults to None
:type scenario_id: str, optional
:param executable_ids: IDs of the executables the configurations should have configured, defaults to None
:type executable_ids: List[str], optional
:param top: Number of configurations to be retrieved, defaults to None
:type top: int, optional
:param skip: Number of configurations to be skipped, from the list of the queried configurations, defaults to
None
:type skip: int, optional
:param search: Generic search term to be looked for in various attributes of configurations, defaults to None
:type search: str, optional
:param search_case_insensitive: Indicates whether the search should be case insensitive
:type search_case_insensitive: bool, optional
:param expand: Entity whose details to be displayed in the response, defaults to None
:type expand: str, optional
:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default
resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,
defaults to None
:type resource_group: str
: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
:raises: class:`ai_api_client_sdk.exception.AIAPIRequestException` if an unexpected exception occurs while
trying to send a request to the server
:return: An object representing the response from the server
:rtype: class:`ai_api_client_sdk.models.configuration_query_response.ConfigurationQueryResponse`
Methods inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
- __init__(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)
- Initialize self. See help(type(self)) for accurate signature.
- delete(self, *args, **kwargs)
- Deletes the relevant resource. Will be implemented by the respective resource clients
- modify(self, *args, **kwargs)
- Modifies the relevant resource. Will be implemented by the respective resource clients
- query_logs(self, *args, **kwargs)
- Queries the relevant logs. Will be implemented by the respective resource clients
Data descriptors inherited from ai_api_client_sdk.resource_clients.base_client.BaseClient:
- __dict__
- dictionary for instance variables (if defined)
- __weakref__
- list of weak references to the object (if defined)
|