sap-ai-sdk-core 2.9.9__py3-none-any.whl → 3.0.8__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- ai_core_sdk/ai_core_v2_client.py +157 -0
- ai_core_sdk/cli.py +172 -0
- ai_core_sdk/credentials.py +196 -0
- ai_core_sdk/exception.py +11 -0
- ai_core_sdk/helpers/__init__.py +39 -0
- ai_core_sdk/helpers/constants.py +18 -0
- ai_core_sdk/helpers/logging.py +23 -0
- ai_core_sdk/models/__init__.py +33 -0
- ai_core_sdk/models/application.py +37 -0
- ai_core_sdk/models/application_query_response.py +30 -0
- ai_core_sdk/models/application_resource_sync_status.py +34 -0
- ai_core_sdk/models/application_source.py +34 -0
- ai_core_sdk/models/application_status.py +66 -0
- ai_core_sdk/models/base_models.py +62 -0
- ai_core_sdk/models/docker_registry_secret.py +23 -0
- ai_core_sdk/models/docker_registry_secret_query_response.py +30 -0
- ai_core_sdk/models/kpi.py +25 -0
- ai_core_sdk/models/object_store_secret.py +32 -0
- ai_core_sdk/models/object_store_secret_query_response.py +30 -0
- ai_core_sdk/models/repository.py +36 -0
- ai_core_sdk/models/repository_query_response.py +30 -0
- ai_core_sdk/models/repository_status.py +9 -0
- ai_core_sdk/models/resource_group.py +50 -0
- ai_core_sdk/models/resource_group_query_response.py +31 -0
- ai_core_sdk/models/resource_group_status.py +9 -0
- ai_core_sdk/models/secret.py +30 -0
- ai_core_sdk/models/secret_query_response.py +30 -0
- ai_core_sdk/resource_clients/__init__.py +13 -0
- ai_core_sdk/resource_clients/applications_client.py +173 -0
- ai_core_sdk/resource_clients/docker_registry_secrets_client.py +117 -0
- ai_core_sdk/resource_clients/internal_rest_client.py +52 -0
- ai_core_sdk/resource_clients/kpi_client.py +26 -0
- ai_core_sdk/resource_clients/metrics_client.py +131 -0
- ai_core_sdk/resource_clients/object_store_secrets_client.py +215 -0
- ai_core_sdk/resource_clients/repositories_client.py +116 -0
- ai_core_sdk/resource_clients/secrets_client.py +148 -0
- ai_core_sdk/tracking/__init__.py +2 -0
- ai_core_sdk/tracking/tracking.py +215 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.ai_core_v2_client.html +127 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.cli.html +59 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.credentials.html +209 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.exception.html +161 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.helpers.constants.html +90 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.helpers.html +52 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.helpers.logging.html +41 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.html +29 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.models.application.html +79 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.models.application_query_response.html +86 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.models.application_resource_sync_status.html +77 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.models.application_source.html +77 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.models.application_status.html +90 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.models.base_models.html +120 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.models.docker_registry_secret.html +85 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.models.docker_registry_secret_query_response.html +86 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.models.html +40 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.models.kpi.html +73 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.models.object_store_secret.html +71 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.models.object_store_secret_query_response.html +86 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.models.repository.html +77 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.models.repository_query_response.html +86 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.models.repository_status.html +69 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.models.resource_group.html +85 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.models.resource_group_query_response.html +86 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.models.resource_group_status.html +69 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.models.secret.html +76 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.models.secret_query_response.html +86 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.resource_clients.applications_client.html +186 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.resource_clients.docker_registry_secrets_client.html +147 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.resource_clients.html +29 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.resource_clients.internal_rest_client.html +181 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.resource_clients.kpi_client.html +87 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.resource_clients.metrics_client.html +189 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.resource_clients.object_store_secrets_client.html +205 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.resource_clients.repositories_client.html +148 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.resource_clients.resource_groups_client.html +156 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.resource_clients.secrets_client.html +165 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.tracking.html +22 -0
- sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.tracking.tracking.html +224 -0
- sap_ai_sdk_core-3.0.8.dist-info/METADATA +253 -0
- sap_ai_sdk_core-3.0.8.dist-info/RECORD +84 -0
- {sap_ai_sdk_core-2.9.9.dist-info → sap_ai_sdk_core-3.0.8.dist-info}/WHEEL +1 -1
- sap_ai_sdk_core-3.0.8.dist-info/top_level.txt +1 -0
- sap_ai_sdk_core-2.9.9.dist-info/METADATA +0 -43
- sap_ai_sdk_core-2.9.9.dist-info/RECORD +0 -6
- sap_ai_sdk_core-2.9.9.dist-info/top_level.txt +0 -1
- {sap-ai-sdk-core → ai_core_sdk}/__init__.py +0 -0
- {sap_ai_sdk_core-2.9.9.dist-info/licenses → sap_ai_sdk_core-3.0.8.dist-info}/LICENSE +0 -0
|
@@ -0,0 +1,87 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
2
|
+
<html><head><title>Python: module ai_core_sdk.resource_clients.kpi_client</title>
|
|
3
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
4
|
+
</head><body bgcolor="#f0f0f8">
|
|
5
|
+
|
|
6
|
+
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
|
7
|
+
<tr bgcolor="#7799ee">
|
|
8
|
+
<td valign=bottom> <br>
|
|
9
|
+
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="ai_core_sdk.html"><font color="#ffffff">ai_core_sdk</font></a>.<a href="ai_core_sdk.resource_clients.html"><font color="#ffffff">resource_clients</font></a>.kpi_client</strong></big></big></font></td
|
|
10
|
+
><td align=right valign=bottom
|
|
11
|
+
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jenkins/agent/workspace/AI-Foundation_ai-core-sdk_master/ai_core_sdk/resource_clients/kpi_client.py">/home/jenkins/agent/workspace/AI-Foundation_ai-core-sdk_master/ai_core_sdk/resource_clients/kpi_client.py</a></font></td></tr></table>
|
|
12
|
+
<p></p>
|
|
13
|
+
<p>
|
|
14
|
+
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
15
|
+
<tr bgcolor="#ee77aa">
|
|
16
|
+
<td colspan=3 valign=bottom> <br>
|
|
17
|
+
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
|
18
|
+
|
|
19
|
+
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
|
20
|
+
<td width="100%"><dl>
|
|
21
|
+
<dt><font face="helvetica, arial"><a href="ai_api_client_sdk.resource_clients.base_client.html#BaseClient">ai_api_client_sdk.resource_clients.base_client.BaseClient</a>(<a href="builtins.html#object">builtins.object</a>)
|
|
22
|
+
</font></dt><dd>
|
|
23
|
+
<dl>
|
|
24
|
+
<dt><font face="helvetica, arial"><a href="ai_core_sdk.resource_clients.kpi_client.html#KpiClient">KpiClient</a>
|
|
25
|
+
</font></dt></dl>
|
|
26
|
+
</dd>
|
|
27
|
+
</dl>
|
|
28
|
+
<p>
|
|
29
|
+
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
30
|
+
<tr bgcolor="#ffc8d8">
|
|
31
|
+
<td colspan=3 valign=bottom> <br>
|
|
32
|
+
<font color="#000000" face="helvetica, arial"><a name="KpiClient">class <strong>KpiClient</strong></a>(<a href="ai_api_client_sdk.resource_clients.base_client.html#BaseClient">ai_api_client_sdk.resource_clients.base_client.BaseClient</a>)</font></td></tr>
|
|
33
|
+
|
|
34
|
+
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
35
|
+
<td colspan=2><tt><a href="#KpiClient">KpiClient</a>(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)<br>
|
|
36
|
+
<br>
|
|
37
|
+
<a href="#KpiClient">KpiClient</a> is a class implemented for interacting with the analytics kpi<br>
|
|
38
|
+
endpoint of the server. It implements the base class<br>
|
|
39
|
+
:class:`ai_api_client_sdk.resource_clients.base_client.<a href="ai_api_client_sdk.resource_clients.base_client.html#BaseClient">BaseClient</a>`<br> </tt></td></tr>
|
|
40
|
+
<tr><td> </td>
|
|
41
|
+
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
42
|
+
<dd><a href="ai_core_sdk.resource_clients.kpi_client.html#KpiClient">KpiClient</a></dd>
|
|
43
|
+
<dd><a href="ai_api_client_sdk.resource_clients.base_client.html#BaseClient">ai_api_client_sdk.resource_clients.base_client.BaseClient</a></dd>
|
|
44
|
+
<dd><a href="builtins.html#object">builtins.object</a></dd>
|
|
45
|
+
</dl>
|
|
46
|
+
<hr>
|
|
47
|
+
Methods defined here:<br>
|
|
48
|
+
<dl><dt><a name="KpiClient-query"><strong>query</strong></a>(self) -> ai_core_sdk.models.kpi.Kpi</dt><dd><tt>Retrieves the number of executions, artifacts, and deployments<br>
|
|
49
|
+
for each resource group, scenario, and executable.<br>
|
|
50
|
+
<br>
|
|
51
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the<br>
|
|
52
|
+
server<br>
|
|
53
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPINotFoundException` if a 404 response is received from the<br>
|
|
54
|
+
server<br>
|
|
55
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
56
|
+
server<br>
|
|
57
|
+
:return: The retrieved KPI data<br>
|
|
58
|
+
:rtype: class:`ai_core_sdk.models.kpi.Kpi`</tt></dd></dl>
|
|
59
|
+
|
|
60
|
+
<hr>
|
|
61
|
+
Methods inherited from <a href="ai_api_client_sdk.resource_clients.base_client.html#BaseClient">ai_api_client_sdk.resource_clients.base_client.BaseClient</a>:<br>
|
|
62
|
+
<dl><dt><a name="KpiClient-__init__"><strong>__init__</strong></a>(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)</dt><dd><tt>Initialize self. See help(type(self)) for accurate signature.</tt></dd></dl>
|
|
63
|
+
|
|
64
|
+
<dl><dt><a name="KpiClient-bulk_modify"><strong>bulk_modify</strong></a>(self, *args, **kwargs)</dt><dd><tt>Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients</tt></dd></dl>
|
|
65
|
+
|
|
66
|
+
<dl><dt><a name="KpiClient-count"><strong>count</strong></a>(self, *args, **kwargs)</dt><dd><tt>Counts the relevant resources. Will be implemented by the respective resource clients</tt></dd></dl>
|
|
67
|
+
|
|
68
|
+
<dl><dt><a name="KpiClient-create"><strong>create</strong></a>(self, *args, **kwargs)</dt><dd><tt>Creates the relevant resource. Will be implemented by the respective resource clients</tt></dd></dl>
|
|
69
|
+
|
|
70
|
+
<dl><dt><a name="KpiClient-delete"><strong>delete</strong></a>(self, *args, **kwargs)</dt><dd><tt>Deletes the relevant resource. Will be implemented by the respective resource clients</tt></dd></dl>
|
|
71
|
+
|
|
72
|
+
<dl><dt><a name="KpiClient-get"><strong>get</strong></a>(self, *args, **kwargs)</dt><dd><tt>Retrieves the relevant resource. Will be implemented by the respective resource clients</tt></dd></dl>
|
|
73
|
+
|
|
74
|
+
<dl><dt><a name="KpiClient-modify"><strong>modify</strong></a>(self, *args, **kwargs)</dt><dd><tt>Modifies the relevant resource. Will be implemented by the respective resource clients</tt></dd></dl>
|
|
75
|
+
|
|
76
|
+
<dl><dt><a name="KpiClient-query_logs"><strong>query_logs</strong></a>(self, *args, **kwargs)</dt><dd><tt>Queries the relevant logs. Will be implemented by the respective resource clients</tt></dd></dl>
|
|
77
|
+
|
|
78
|
+
<hr>
|
|
79
|
+
Data descriptors inherited from <a href="ai_api_client_sdk.resource_clients.base_client.html#BaseClient">ai_api_client_sdk.resource_clients.base_client.BaseClient</a>:<br>
|
|
80
|
+
<dl><dt><strong>__dict__</strong></dt>
|
|
81
|
+
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
82
|
+
</dl>
|
|
83
|
+
<dl><dt><strong>__weakref__</strong></dt>
|
|
84
|
+
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
85
|
+
</dl>
|
|
86
|
+
</td></tr></table></td></tr></table>
|
|
87
|
+
</body></html>
|
|
@@ -0,0 +1,189 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
2
|
+
<html><head><title>Python: module ai_core_sdk.resource_clients.metrics_client</title>
|
|
3
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
4
|
+
</head><body bgcolor="#f0f0f8">
|
|
5
|
+
|
|
6
|
+
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
|
7
|
+
<tr bgcolor="#7799ee">
|
|
8
|
+
<td valign=bottom> <br>
|
|
9
|
+
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="ai_core_sdk.html"><font color="#ffffff">ai_core_sdk</font></a>.<a href="ai_core_sdk.resource_clients.html"><font color="#ffffff">resource_clients</font></a>.metrics_client</strong></big></big></font></td
|
|
10
|
+
><td align=right valign=bottom
|
|
11
|
+
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jenkins/agent/workspace/AI-Foundation_ai-core-sdk_master/ai_core_sdk/resource_clients/metrics_client.py">/home/jenkins/agent/workspace/AI-Foundation_ai-core-sdk_master/ai_core_sdk/resource_clients/metrics_client.py</a></font></td></tr></table>
|
|
12
|
+
<p></p>
|
|
13
|
+
<p>
|
|
14
|
+
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
15
|
+
<tr bgcolor="#ee77aa">
|
|
16
|
+
<td colspan=3 valign=bottom> <br>
|
|
17
|
+
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
|
18
|
+
|
|
19
|
+
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
|
20
|
+
<td width="100%"><dl>
|
|
21
|
+
<dt><font face="helvetica, arial"><a href="ai_api_client_sdk.resource_clients.metrics_client.html#MetricsClient">ai_api_client_sdk.resource_clients.metrics_client.MetricsClient</a>(<a href="ai_api_client_sdk.resource_clients.base_client.html#BaseClient">ai_api_client_sdk.resource_clients.base_client.BaseClient</a>)
|
|
22
|
+
</font></dt><dd>
|
|
23
|
+
<dl>
|
|
24
|
+
<dt><font face="helvetica, arial"><a href="ai_core_sdk.resource_clients.metrics_client.html#MetricsCoreClient">MetricsCoreClient</a>
|
|
25
|
+
</font></dt></dl>
|
|
26
|
+
</dd>
|
|
27
|
+
</dl>
|
|
28
|
+
<p>
|
|
29
|
+
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
30
|
+
<tr bgcolor="#ffc8d8">
|
|
31
|
+
<td colspan=3 valign=bottom> <br>
|
|
32
|
+
<font color="#000000" face="helvetica, arial"><a name="MetricsCoreClient">class <strong>MetricsCoreClient</strong></a>(<a href="ai_api_client_sdk.resource_clients.metrics_client.html#MetricsClient">ai_api_client_sdk.resource_clients.metrics_client.MetricsClient</a>)</font></td></tr>
|
|
33
|
+
|
|
34
|
+
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
35
|
+
<td colspan=2><tt><a href="#MetricsCoreClient">MetricsCoreClient</a>(rest_client, execution_id: str = None) -&gt; None<br>
|
|
36
|
+
<br>
|
|
37
|
+
<a href="#MetricsCoreClient">MetricsCoreClient</a> is a class implemented for interacting with the metrics related<br>
|
|
38
|
+
endpoints of the server. It is inherited from the base class<br>
|
|
39
|
+
:class:`ai_api_client_sdk.resource_clients.metrics_client.<a href="ai_api_client_sdk.resource_clients.metrics_client.html#MetricsClient">MetricsClient</a>`<br> </tt></td></tr>
|
|
40
|
+
<tr><td> </td>
|
|
41
|
+
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
42
|
+
<dd><a href="ai_core_sdk.resource_clients.metrics_client.html#MetricsCoreClient">MetricsCoreClient</a></dd>
|
|
43
|
+
<dd><a href="ai_api_client_sdk.resource_clients.metrics_client.html#MetricsClient">ai_api_client_sdk.resource_clients.metrics_client.MetricsClient</a></dd>
|
|
44
|
+
<dd><a href="ai_api_client_sdk.resource_clients.base_client.html#BaseClient">ai_api_client_sdk.resource_clients.base_client.BaseClient</a></dd>
|
|
45
|
+
<dd><a href="builtins.html#object">builtins.object</a></dd>
|
|
46
|
+
</dl>
|
|
47
|
+
<hr>
|
|
48
|
+
Methods defined here:<br>
|
|
49
|
+
<dl><dt><a name="MetricsCoreClient-__init__"><strong>__init__</strong></a>(self, rest_client, execution_id: str = None) -> None</dt><dd><tt>Initialize self. See help(type(self)) for accurate signature.</tt></dd></dl>
|
|
50
|
+
|
|
51
|
+
<dl><dt><a name="MetricsCoreClient-log_metrics"><strong>log_metrics</strong></a>(self, metrics: List[ai_api_client_sdk.models.metric.Metric], execution_id: str = '', artifact_name: str = None, resource_group: str = None) -> None</dt><dd><tt>Creates or updates the metrics for an execution.<br>
|
|
52
|
+
<br>
|
|
53
|
+
:param metrics: List of the metrics related to the execution,<br>
|
|
54
|
+
:type metrics: List[class:`ai_api_client_sdk.metric.Metric`]<br>
|
|
55
|
+
:param execution_id: ID of the execution, of which the metrics should be modified.<br>
|
|
56
|
+
:type execution_id: str<br>
|
|
57
|
+
:param artifact_name: Name of the artifact to associate with a metric, defaults to None<br>
|
|
58
|
+
:type artifact_name: str<br>
|
|
59
|
+
:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default<br>
|
|
60
|
+
resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,<br>
|
|
61
|
+
defaults to None<br>
|
|
62
|
+
:type resource_group: str<br>
|
|
63
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
64
|
+
server<br>
|
|
65
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
66
|
+
server</tt></dd></dl>
|
|
67
|
+
|
|
68
|
+
<dl><dt><a name="MetricsCoreClient-modify"><strong>modify</strong></a>(self, execution_id: str = '', metrics: List[ai_api_client_sdk.models.metric.Metric] = None, tags: List[ai_api_client_sdk.models.metric_tag.MetricTag] = None, custom_info: List[ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo] = None, resource_group: str = None) -> None</dt><dd><tt>Creates or updates the metrics for an execution.<br>
|
|
69
|
+
<br>
|
|
70
|
+
:param execution_id: ID of the execution, of which the metrics should be modified.<br>
|
|
71
|
+
:type execution_id: str<br>
|
|
72
|
+
:param metrics: List of the metrics related to the execution, defaults to None<br>
|
|
73
|
+
:type metrics: List[class:`ai_api_client_sdk.metric.Metric`], optional<br>
|
|
74
|
+
:param tags: List of the tags related to the execution, defaults to None<br>
|
|
75
|
+
:type tags: List[class:'ai_api_client_sdk.models.metric_tag.MetricTag'], optional<br>
|
|
76
|
+
:param custom_info: List of custom info related to the execution, defaults to None<br>
|
|
77
|
+
:type custom_info: List[class:`ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo`], optional<br>
|
|
78
|
+
:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default<br>
|
|
79
|
+
resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,<br>
|
|
80
|
+
defaults to None<br>
|
|
81
|
+
:type resource_group: str<br>
|
|
82
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
83
|
+
server<br>
|
|
84
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
85
|
+
server</tt></dd></dl>
|
|
86
|
+
|
|
87
|
+
<dl><dt><a name="MetricsCoreClient-set_custom_info"><strong>set_custom_info</strong></a>(self, custom_info: List[ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo], execution_id: str = '', resource_group: str = None) -> None</dt><dd><tt>log custom info against the given execution<br>
|
|
88
|
+
captures consumption semantics for the metrics or complex metric in JSON format.<br>
|
|
89
|
+
<br>
|
|
90
|
+
<br>
|
|
91
|
+
:param custom_info: List of custom info related to the execution<br>
|
|
92
|
+
:type custom_info: List[class:`ai_api_client_sdk.models.metric_custom_info.MetricCustomInfo`], optional<br>
|
|
93
|
+
:param execution_id: ID of the execution, of which the metrics should be modified.<br>
|
|
94
|
+
:type execution_id: str<br>
|
|
95
|
+
:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default<br>
|
|
96
|
+
resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,<br>
|
|
97
|
+
defaults to None<br>
|
|
98
|
+
:type resource_group: str<br>
|
|
99
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
100
|
+
server<br>
|
|
101
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
102
|
+
server</tt></dd></dl>
|
|
103
|
+
|
|
104
|
+
<dl><dt><a name="MetricsCoreClient-set_tags"><strong>set_tags</strong></a>(self, tags: List[ai_api_client_sdk.models.metric_tag.MetricTag], execution_id: str = '', resource_group: str = None) -> None</dt><dd><tt>log tags against the given execution<br>
|
|
105
|
+
<br>
|
|
106
|
+
:param tags: List of the tags related to the execution, defaults to None<br>
|
|
107
|
+
:type tags: List[class:'ai_api_client_sdk.models.metric_tag.MetricTag']<br>
|
|
108
|
+
:param execution_id: ID of the execution, of which the metrics should be modified.<br>
|
|
109
|
+
:type execution_id: str<br>
|
|
110
|
+
:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default<br>
|
|
111
|
+
resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,<br>
|
|
112
|
+
defaults to None<br>
|
|
113
|
+
:type resource_group: str<br>
|
|
114
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
115
|
+
server<br>
|
|
116
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
117
|
+
server</tt></dd></dl>
|
|
118
|
+
|
|
119
|
+
<hr>
|
|
120
|
+
Methods inherited from <a href="ai_api_client_sdk.resource_clients.metrics_client.html#MetricsClient">ai_api_client_sdk.resource_clients.metrics_client.MetricsClient</a>:<br>
|
|
121
|
+
<dl><dt><a name="MetricsCoreClient-delete"><strong>delete</strong></a>(self, execution_id: str, resource_group: str = None) -> None</dt><dd><tt>Deletes the metrics.<br>
|
|
122
|
+
<br>
|
|
123
|
+
:param execution_id: ID of the execution, of which the metrics should be deleted.<br>
|
|
124
|
+
:type execution_id: str<br>
|
|
125
|
+
:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default<br>
|
|
126
|
+
resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,<br>
|
|
127
|
+
defaults to None<br>
|
|
128
|
+
:type resource_group: str<br>
|
|
129
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
130
|
+
server<br>
|
|
131
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the<br>
|
|
132
|
+
server<br>
|
|
133
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPINotFoundException` if a 404 response is received from the<br>
|
|
134
|
+
server<br>
|
|
135
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
136
|
+
server</tt></dd></dl>
|
|
137
|
+
|
|
138
|
+
<dl><dt><a name="MetricsCoreClient-query"><strong>query</strong></a>(self, filter: str = None, execution_ids: List[str] = None, select: List[str] = None, resource_group: str = None) -> ai_api_client_sdk.models.metrics_query_response.MetricsQueryResponse</dt><dd><tt>Queries the metrics.<br>
|
|
139
|
+
<br>
|
|
140
|
+
:param filter: Deprecated. Use parameter execution_ids instead. A filter expression that filters the metric<br>
|
|
141
|
+
resources using execution IDs. User can only use in, eq operators in filter expression, defaults to None<br>
|
|
142
|
+
:type filter: str, optional<br>
|
|
143
|
+
:param execution_ids: IDs of the executions, of which the metrics should be retrieved, defaults to None<br>
|
|
144
|
+
:type execution_ids: List[str], optional<br>
|
|
145
|
+
:param select: Values of select can be metrics,tags,customInfo or any of the combinations of these or *. <br>
|
|
146
|
+
Can be used to select(project) only the resources specified<br>
|
|
147
|
+
:type select: List[str], optional<br>
|
|
148
|
+
:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default<br>
|
|
149
|
+
resource group in the :class:`ai_api_client_sdk.ai_api_v2_client.AIAPIV2Client` should be specified,<br>
|
|
150
|
+
defaults to None<br>
|
|
151
|
+
:type resource_group: str<br>
|
|
152
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
153
|
+
server<br>
|
|
154
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the<br>
|
|
155
|
+
server<br>
|
|
156
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
157
|
+
server<br>
|
|
158
|
+
:return: An object representing the response from the server<br>
|
|
159
|
+
:rtype: class:`ai_api_client_sdk.models.metrics_query_response.MetricsQueryResponse`</tt></dd></dl>
|
|
160
|
+
|
|
161
|
+
<hr>
|
|
162
|
+
Methods inherited from <a href="ai_api_client_sdk.resource_clients.base_client.html#BaseClient">ai_api_client_sdk.resource_clients.base_client.BaseClient</a>:<br>
|
|
163
|
+
<dl><dt><a name="MetricsCoreClient-bulk_modify"><strong>bulk_modify</strong></a>(self, *args, **kwargs)</dt><dd><tt>Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients</tt></dd></dl>
|
|
164
|
+
|
|
165
|
+
<dl><dt><a name="MetricsCoreClient-count"><strong>count</strong></a>(self, *args, **kwargs)</dt><dd><tt>Counts the relevant resources. Will be implemented by the respective resource clients</tt></dd></dl>
|
|
166
|
+
|
|
167
|
+
<dl><dt><a name="MetricsCoreClient-create"><strong>create</strong></a>(self, *args, **kwargs)</dt><dd><tt>Creates the relevant resource. Will be implemented by the respective resource clients</tt></dd></dl>
|
|
168
|
+
|
|
169
|
+
<dl><dt><a name="MetricsCoreClient-get"><strong>get</strong></a>(self, *args, **kwargs)</dt><dd><tt>Retrieves the relevant resource. Will be implemented by the respective resource clients</tt></dd></dl>
|
|
170
|
+
|
|
171
|
+
<dl><dt><a name="MetricsCoreClient-query_logs"><strong>query_logs</strong></a>(self, *args, **kwargs)</dt><dd><tt>Queries the relevant logs. Will be implemented by the respective resource clients</tt></dd></dl>
|
|
172
|
+
|
|
173
|
+
<hr>
|
|
174
|
+
Data descriptors inherited from <a href="ai_api_client_sdk.resource_clients.base_client.html#BaseClient">ai_api_client_sdk.resource_clients.base_client.BaseClient</a>:<br>
|
|
175
|
+
<dl><dt><strong>__dict__</strong></dt>
|
|
176
|
+
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
177
|
+
</dl>
|
|
178
|
+
<dl><dt><strong>__weakref__</strong></dt>
|
|
179
|
+
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
180
|
+
</dl>
|
|
181
|
+
</td></tr></table></td></tr></table><p>
|
|
182
|
+
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
183
|
+
<tr bgcolor="#55aa55">
|
|
184
|
+
<td colspan=3 valign=bottom> <br>
|
|
185
|
+
<font color="#ffffff" face="helvetica, arial"><big><strong>Data</strong></big></font></td></tr>
|
|
186
|
+
|
|
187
|
+
<tr><td bgcolor="#55aa55"><tt> </tt></td><td> </td>
|
|
188
|
+
<td width="100%"><strong>List</strong> = typing.List</td></tr></table>
|
|
189
|
+
</body></html>
|
sap_ai_sdk_core-3.0.8.data/data/docs/ai_core_sdk.resource_clients.object_store_secrets_client.html
ADDED
|
@@ -0,0 +1,205 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
2
|
+
<html><head><title>Python: module ai_core_sdk.resource_clients.object_store_secrets_client</title>
|
|
3
|
+
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
|
|
4
|
+
</head><body bgcolor="#f0f0f8">
|
|
5
|
+
|
|
6
|
+
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="heading">
|
|
7
|
+
<tr bgcolor="#7799ee">
|
|
8
|
+
<td valign=bottom> <br>
|
|
9
|
+
<font color="#ffffff" face="helvetica, arial"> <br><big><big><strong><a href="ai_core_sdk.html"><font color="#ffffff">ai_core_sdk</font></a>.<a href="ai_core_sdk.resource_clients.html"><font color="#ffffff">resource_clients</font></a>.object_store_secrets_client</strong></big></big></font></td
|
|
10
|
+
><td align=right valign=bottom
|
|
11
|
+
><font color="#ffffff" face="helvetica, arial"><a href=".">index</a><br><a href="file:/home/jenkins/agent/workspace/AI-Foundation_ai-core-sdk_master/ai_core_sdk/resource_clients/object_store_secrets_client.py">/home/jenkins/agent/workspace/AI-Foundation_ai-core-sdk_master/ai_core_sdk/resource_clients/object_store_secrets_client.py</a></font></td></tr></table>
|
|
12
|
+
<p></p>
|
|
13
|
+
<p>
|
|
14
|
+
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
15
|
+
<tr bgcolor="#ee77aa">
|
|
16
|
+
<td colspan=3 valign=bottom> <br>
|
|
17
|
+
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
|
18
|
+
|
|
19
|
+
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
|
20
|
+
<td width="100%"><dl>
|
|
21
|
+
<dt><font face="helvetica, arial"><a href="ai_api_client_sdk.resource_clients.base_client.html#BaseClient">ai_api_client_sdk.resource_clients.base_client.BaseClient</a>(<a href="builtins.html#object">builtins.object</a>)
|
|
22
|
+
</font></dt><dd>
|
|
23
|
+
<dl>
|
|
24
|
+
<dt><font face="helvetica, arial"><a href="ai_core_sdk.resource_clients.object_store_secrets_client.html#ObjectStoreSecretsClient">ObjectStoreSecretsClient</a>
|
|
25
|
+
</font></dt></dl>
|
|
26
|
+
</dd>
|
|
27
|
+
</dl>
|
|
28
|
+
<p>
|
|
29
|
+
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
30
|
+
<tr bgcolor="#ffc8d8">
|
|
31
|
+
<td colspan=3 valign=bottom> <br>
|
|
32
|
+
<font color="#000000" face="helvetica, arial"><a name="ObjectStoreSecretsClient">class <strong>ObjectStoreSecretsClient</strong></a>(<a href="ai_api_client_sdk.resource_clients.base_client.html#BaseClient">ai_api_client_sdk.resource_clients.base_client.BaseClient</a>)</font></td></tr>
|
|
33
|
+
|
|
34
|
+
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
35
|
+
<td colspan=2><tt><a href="#ObjectStoreSecretsClient">ObjectStoreSecretsClient</a>(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)<br>
|
|
36
|
+
<br>
|
|
37
|
+
<a href="#ObjectStoreSecretsClient">ObjectStoreSecretsClient</a> is a class implemented for interacting with the object store secret related<br>
|
|
38
|
+
endpoints of the server. It implements the base class<br>
|
|
39
|
+
:class:`ai_api_client_sdk.resource_clients.base_client.<a href="ai_api_client_sdk.resource_clients.base_client.html#BaseClient">BaseClient</a>`<br> </tt></td></tr>
|
|
40
|
+
<tr><td> </td>
|
|
41
|
+
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
42
|
+
<dd><a href="ai_core_sdk.resource_clients.object_store_secrets_client.html#ObjectStoreSecretsClient">ObjectStoreSecretsClient</a></dd>
|
|
43
|
+
<dd><a href="ai_api_client_sdk.resource_clients.base_client.html#BaseClient">ai_api_client_sdk.resource_clients.base_client.BaseClient</a></dd>
|
|
44
|
+
<dd><a href="builtins.html#object">builtins.object</a></dd>
|
|
45
|
+
</dl>
|
|
46
|
+
<hr>
|
|
47
|
+
Methods defined here:<br>
|
|
48
|
+
<dl><dt><a name="ObjectStoreSecretsClient-create"><strong>create</strong></a>(self, name: str, type: str, data: dict, bucket: str = None, endpoint: str = None, region: str = None, path_prefix: str = None, verifyssl: str = None, usehttps: str = None, resource_group: str = None) -> ai_core_sdk.models.base_models.Message</dt><dd><tt>Creates an object store secret.<br>
|
|
49
|
+
<br>
|
|
50
|
+
:param name: name of the object store secret<br>
|
|
51
|
+
:type name: str<br>
|
|
52
|
+
:param type: type of object storage<br>
|
|
53
|
+
:type type: str<br>
|
|
54
|
+
:param data: data to be posted<br>
|
|
55
|
+
:type data: str<br>
|
|
56
|
+
:param bucket: name of the bucket<br>
|
|
57
|
+
:type bucket: str<br>
|
|
58
|
+
:param endpoint: endpoint of object storage<br>
|
|
59
|
+
:type endpoint: str<br>
|
|
60
|
+
:param region: region of object storage<br>
|
|
61
|
+
:type region: str<br>
|
|
62
|
+
:param path_prefix: path prefix<br>
|
|
63
|
+
:type path_prefix: str<br>
|
|
64
|
+
:param verifyssl: verify ssl<br>
|
|
65
|
+
:type verifyssl: str<br>
|
|
66
|
+
:param usehttps: use https<br>
|
|
67
|
+
:type usehttps: str<br>
|
|
68
|
+
:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default<br>
|
|
69
|
+
resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,<br>
|
|
70
|
+
defaults to None<br>
|
|
71
|
+
:type resource_group: str<br>
|
|
72
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
73
|
+
server<br>
|
|
74
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the<br>
|
|
75
|
+
server<br>
|
|
76
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIForbiddenException` if a 403 response is received from the<br>
|
|
77
|
+
server<br>
|
|
78
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIConflictException` if a 409 response is received from the<br>
|
|
79
|
+
server<br>
|
|
80
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
81
|
+
server<br>
|
|
82
|
+
:return: A list of metadata of available secrets<br>
|
|
83
|
+
:rtype: class:`ai_core_sdk.models.base_models.BasicNameResponse`</tt></dd></dl>
|
|
84
|
+
|
|
85
|
+
<dl><dt><a name="ObjectStoreSecretsClient-delete"><strong>delete</strong></a>(self, name: str, resource_group: str = None) -> ai_api_client_sdk.models.base_models.BasicResponse</dt><dd><tt>Deletes the object store secret.<br>
|
|
86
|
+
<br>
|
|
87
|
+
:param name: name of the object store secret to be deleted<br>
|
|
88
|
+
:type name: str<br>
|
|
89
|
+
:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default<br>
|
|
90
|
+
resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,<br>
|
|
91
|
+
defaults to None<br>
|
|
92
|
+
:type resource_group: str<br>
|
|
93
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
94
|
+
server<br>
|
|
95
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the<br>
|
|
96
|
+
server<br>
|
|
97
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIForbiddenException` if a 403 response is received from the<br>
|
|
98
|
+
server<br>
|
|
99
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPINotFoundException` if a 404 response is received from the<br>
|
|
100
|
+
server<br>
|
|
101
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
102
|
+
server<br>
|
|
103
|
+
:return: An object representing the response from the server<br>
|
|
104
|
+
:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`</tt></dd></dl>
|
|
105
|
+
|
|
106
|
+
<dl><dt><a name="ObjectStoreSecretsClient-get"><strong>get</strong></a>(self, name: str, resource_group: str = None) -> ai_core_sdk.models.object_store_secret.ObjectStoreSecret</dt><dd><tt>Retrieves the object store secret from the server.<br>
|
|
107
|
+
<br>
|
|
108
|
+
:param name: name of the object store secret to be retrieved<br>
|
|
109
|
+
:type name: str<br>
|
|
110
|
+
:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default<br>
|
|
111
|
+
resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,<br>
|
|
112
|
+
defaults to None<br>
|
|
113
|
+
:type resource_group: str<br>
|
|
114
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
115
|
+
server<br>
|
|
116
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the<br>
|
|
117
|
+
server<br>
|
|
118
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIForbiddenException` if a 403 response is received from the<br>
|
|
119
|
+
server<br>
|
|
120
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPINotFoundException` if a 404 response is received from the<br>
|
|
121
|
+
server<br>
|
|
122
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
123
|
+
server<br>
|
|
124
|
+
:return: The retrieved object store secret<br>
|
|
125
|
+
:rtype: class:`ai_core_sdk.models.object_store_secret.ObjectStoreSecret`</tt></dd></dl>
|
|
126
|
+
|
|
127
|
+
<dl><dt><a name="ObjectStoreSecretsClient-modify"><strong>modify</strong></a>(self, name: str, type: str, data: dict, bucket: str = None, endpoint: str = None, region: str = None, path_prefix: str = None, verifyssl: str = None, usehttps: str = None, resource_group: str = None) -> ai_api_client_sdk.models.base_models.BasicResponse</dt><dd><tt>Modifies the object store secret<br>
|
|
128
|
+
<br>
|
|
129
|
+
:param name: name of the object store secret to be modified<br>
|
|
130
|
+
:type name: str<br>
|
|
131
|
+
:param type: type of object storage<br>
|
|
132
|
+
:type type: str<br>
|
|
133
|
+
:param data: data to be posted<br>
|
|
134
|
+
:type data: str<br>
|
|
135
|
+
:param bucket: name of the bucket<br>
|
|
136
|
+
:type bucket: str<br>
|
|
137
|
+
:param endpoint: endpoint of object storage<br>
|
|
138
|
+
:type endpoint: str<br>
|
|
139
|
+
:param region: region of object storage<br>
|
|
140
|
+
:type region: str<br>
|
|
141
|
+
:param path_prefix: path prefix<br>
|
|
142
|
+
:type path_prefix: str<br>
|
|
143
|
+
:param verifyssl: verify ssl<br>
|
|
144
|
+
:type verifyssl: str<br>
|
|
145
|
+
:param usehttps: use https<br>
|
|
146
|
+
:type usehttps: str<br>
|
|
147
|
+
:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default<br>
|
|
148
|
+
resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,<br>
|
|
149
|
+
defaults to None<br>
|
|
150
|
+
:type resource_group: str<br>
|
|
151
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
152
|
+
server<br>
|
|
153
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the<br>
|
|
154
|
+
server<br>
|
|
155
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIForbiddenException` if a 403 response is received from the<br>
|
|
156
|
+
server<br>
|
|
157
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPINotFoundException` if a 404 response is received from the<br>
|
|
158
|
+
server<br>
|
|
159
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIPreconditionFailedException` if a 412 response is received from<br>
|
|
160
|
+
the server<br>
|
|
161
|
+
:return: An object representing the response from the server<br>
|
|
162
|
+
:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`</tt></dd></dl>
|
|
163
|
+
|
|
164
|
+
<dl><dt><a name="ObjectStoreSecretsClient-query"><strong>query</strong></a>(self, top: int = None, skip: int = None, resource_group: str = None) -> ai_core_sdk.models.object_store_secret_query_response.ObjectStoreSecretQueryResponse</dt><dd><tt>Returns the object store secrets.<br>
|
|
165
|
+
<br>
|
|
166
|
+
:param top: Number of object store secrets to be retrieved, defaults to None<br>
|
|
167
|
+
:type top: int, optional<br>
|
|
168
|
+
:param skip: Number of object store secrets to be skipped, from the list of the queried object store<br>
|
|
169
|
+
secrets, defaults to None<br>
|
|
170
|
+
:type skip: int, optional<br>
|
|
171
|
+
:param resource_group: Resource Group which the request should be sent on behalf. Either this or a default<br>
|
|
172
|
+
resource group in the :class:`ai_core_sdk.ai_core_v2_client.AICoreV2Client` should be specified,<br>
|
|
173
|
+
defaults to None<br>
|
|
174
|
+
:type resource_group: str<br>
|
|
175
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
176
|
+
server<br>
|
|
177
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the<br>
|
|
178
|
+
server<br>
|
|
179
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIForbiddenException` if a 403 response is received from the<br>
|
|
180
|
+
server<br>
|
|
181
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
182
|
+
server<br>
|
|
183
|
+
:return: A list of object store secrets<br>
|
|
184
|
+
:rtype: class:`ai_core_sdk.models.object_store_secret_query_response.ObjectStoreSecretQueryResponse`</tt></dd></dl>
|
|
185
|
+
|
|
186
|
+
<hr>
|
|
187
|
+
Methods inherited from <a href="ai_api_client_sdk.resource_clients.base_client.html#BaseClient">ai_api_client_sdk.resource_clients.base_client.BaseClient</a>:<br>
|
|
188
|
+
<dl><dt><a name="ObjectStoreSecretsClient-__init__"><strong>__init__</strong></a>(self, rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)</dt><dd><tt>Initialize self. See help(type(self)) for accurate signature.</tt></dd></dl>
|
|
189
|
+
|
|
190
|
+
<dl><dt><a name="ObjectStoreSecretsClient-bulk_modify"><strong>bulk_modify</strong></a>(self, *args, **kwargs)</dt><dd><tt>Modifies multiple instances of the relevant resource. Will be implemented by the respective resource clients</tt></dd></dl>
|
|
191
|
+
|
|
192
|
+
<dl><dt><a name="ObjectStoreSecretsClient-count"><strong>count</strong></a>(self, *args, **kwargs)</dt><dd><tt>Counts the relevant resources. Will be implemented by the respective resource clients</tt></dd></dl>
|
|
193
|
+
|
|
194
|
+
<dl><dt><a name="ObjectStoreSecretsClient-query_logs"><strong>query_logs</strong></a>(self, *args, **kwargs)</dt><dd><tt>Queries the relevant logs. Will be implemented by the respective resource clients</tt></dd></dl>
|
|
195
|
+
|
|
196
|
+
<hr>
|
|
197
|
+
Data descriptors inherited from <a href="ai_api_client_sdk.resource_clients.base_client.html#BaseClient">ai_api_client_sdk.resource_clients.base_client.BaseClient</a>:<br>
|
|
198
|
+
<dl><dt><strong>__dict__</strong></dt>
|
|
199
|
+
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
200
|
+
</dl>
|
|
201
|
+
<dl><dt><strong>__weakref__</strong></dt>
|
|
202
|
+
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
203
|
+
</dl>
|
|
204
|
+
</td></tr></table></td></tr></table>
|
|
205
|
+
</body></html>
|