sap-ai-sdk-core 2.9.9__py3-none-any.whl → 3.0.3__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.3.data/data/docs/ai_core_sdk.ai_core_v2_client.html +127 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.cli.html +59 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.credentials.html +209 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.exception.html +161 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.helpers.constants.html +90 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.helpers.html +52 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.helpers.logging.html +41 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.html +29 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.models.application.html +79 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.models.application_query_response.html +86 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.models.application_resource_sync_status.html +77 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.models.application_source.html +77 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.models.application_status.html +90 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.models.base_models.html +120 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.models.docker_registry_secret.html +85 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.models.docker_registry_secret_query_response.html +86 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.models.html +40 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.models.kpi.html +73 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.models.object_store_secret.html +71 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.models.object_store_secret_query_response.html +86 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.models.repository.html +77 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.models.repository_query_response.html +86 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.models.repository_status.html +69 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.models.resource_group.html +85 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.models.resource_group_query_response.html +86 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.models.resource_group_status.html +69 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.models.secret.html +76 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.models.secret_query_response.html +86 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.resource_clients.applications_client.html +186 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.resource_clients.docker_registry_secrets_client.html +147 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.resource_clients.html +29 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.resource_clients.internal_rest_client.html +181 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.resource_clients.kpi_client.html +87 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.resource_clients.metrics_client.html +189 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.resource_clients.object_store_secrets_client.html +205 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.resource_clients.repositories_client.html +148 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.resource_clients.resource_groups_client.html +156 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.resource_clients.secrets_client.html +165 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.tracking.html +22 -0
- sap_ai_sdk_core-3.0.3.data/data/docs/ai_core_sdk.tracking.tracking.html +224 -0
- sap_ai_sdk_core-3.0.3.dist-info/METADATA +253 -0
- sap_ai_sdk_core-3.0.3.dist-info/RECORD +84 -0
- {sap_ai_sdk_core-2.9.9.dist-info → sap_ai_sdk_core-3.0.3.dist-info}/WHEEL +1 -1
- sap_ai_sdk_core-3.0.3.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.3.dist-info}/LICENSE +0 -0
|
@@ -0,0 +1,186 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
2
|
+
<html><head><title>Python: module ai_core_sdk.resource_clients.applications_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>.applications_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/applications_client.py">/home/jenkins/agent/workspace/AI-Foundation_ai-core-sdk_master/ai_core_sdk/resource_clients/applications_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.applications_client.html#ApplicationsClient">ApplicationsClient</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="ApplicationsClient">class <strong>ApplicationsClient</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="#ApplicationsClient">ApplicationsClient</a>(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)<br>
|
|
36
|
+
<br>
|
|
37
|
+
<a href="#ApplicationsClient">ApplicationsClient</a> is a class implemented for interacting with the applications 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.applications_client.html#ApplicationsClient">ApplicationsClient</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="ApplicationsClient-create"><strong>create</strong></a>(self, revision: str, path: str, application_name: str = None, repository_name: str = None, repository_url: str = None) -> ai_api_client_sdk.models.base_models.BasicResponse</dt><dd><tt>Creates an application.<br>
|
|
49
|
+
<br>
|
|
50
|
+
:param revision: revision to synchronize<br>
|
|
51
|
+
:type revision: str<br>
|
|
52
|
+
:param path: within the repository to synchronize<br>
|
|
53
|
+
:type path: str<br>
|
|
54
|
+
:param application_name: Name of the application<br>
|
|
55
|
+
:type application_name: str, optional<br>
|
|
56
|
+
:param repository_name: Name of the repository to synchronize. Either this or the repository_url needs to be<br>
|
|
57
|
+
provided<br>
|
|
58
|
+
:type repository_name: str, optional<br>
|
|
59
|
+
:param repository_url: URL of the repository to synchronize. Either this or the repository_name needs to be<br>
|
|
60
|
+
provided<br>
|
|
61
|
+
:type repository_url: str, optional<br>
|
|
62
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
63
|
+
server<br>
|
|
64
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the<br>
|
|
65
|
+
server<br>
|
|
66
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
67
|
+
server<br>
|
|
68
|
+
:return: An object representing the response from the server<br>
|
|
69
|
+
:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`</tt></dd></dl>
|
|
70
|
+
|
|
71
|
+
<dl><dt><a name="ApplicationsClient-delete"><strong>delete</strong></a>(self, application_name: str) -> ai_api_client_sdk.models.base_models.BasicResponse</dt><dd><tt>Deletes the application.<br>
|
|
72
|
+
<br>
|
|
73
|
+
:param application_name: name of the application to be deleted<br>
|
|
74
|
+
:type application_name: str<br>
|
|
75
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
76
|
+
server<br>
|
|
77
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the<br>
|
|
78
|
+
server<br>
|
|
79
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPINotFoundException` if a 404 response is received from the<br>
|
|
80
|
+
server<br>
|
|
81
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIPreconditionFailedException` if a 412 response is received from<br>
|
|
82
|
+
the server<br>
|
|
83
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
84
|
+
server<br>
|
|
85
|
+
:return: An object representing the response from the server<br>
|
|
86
|
+
:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`</tt></dd></dl>
|
|
87
|
+
|
|
88
|
+
<dl><dt><a name="ApplicationsClient-get"><strong>get</strong></a>(self, application_name: str) -> ai_core_sdk.models.application.Application</dt><dd><tt>Retrieves the application from the server.<br>
|
|
89
|
+
<br>
|
|
90
|
+
:param application_name: name of the application to be retrieved<br>
|
|
91
|
+
:type application_name: str<br>
|
|
92
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
93
|
+
server<br>
|
|
94
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the<br>
|
|
95
|
+
server<br>
|
|
96
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPINotFoundException` if a 404 response is received from the<br>
|
|
97
|
+
server<br>
|
|
98
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
99
|
+
server<br>
|
|
100
|
+
:return: The retrieved application<br>
|
|
101
|
+
:rtype: class:`ai_core_sdk.models.application.Application`</tt></dd></dl>
|
|
102
|
+
|
|
103
|
+
<dl><dt><a name="ApplicationsClient-get_status"><strong>get_status</strong></a>(self, application_name: str) -> ai_core_sdk.models.application_status.ApplicationStatus</dt><dd><tt>Retrieves the application status from the server.<br>
|
|
104
|
+
<br>
|
|
105
|
+
:param application_name: name of the application<br>
|
|
106
|
+
:type application_name: str<br>
|
|
107
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
108
|
+
server<br>
|
|
109
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the<br>
|
|
110
|
+
server<br>
|
|
111
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPINotFoundException` if a 404 response is received from the<br>
|
|
112
|
+
server<br>
|
|
113
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
114
|
+
server<br>
|
|
115
|
+
:return: The retrieved application status<br>
|
|
116
|
+
:rtype: class:`ai_core_sdk.models.application_status.ApplicationStatus`</tt></dd></dl>
|
|
117
|
+
|
|
118
|
+
<dl><dt><a name="ApplicationsClient-modify"><strong>modify</strong></a>(self, application_name: str, repository_url: str, path: str, revision: str) -> ai_api_client_sdk.models.base_models.BasicResponse</dt><dd><tt>Modifies the application<br>
|
|
119
|
+
<br>
|
|
120
|
+
:param application_name: name of the application to be modified<br>
|
|
121
|
+
:type name: str<br>
|
|
122
|
+
:param repository_url:<br>
|
|
123
|
+
:type repository_url: str<br>
|
|
124
|
+
:param revision:<br>
|
|
125
|
+
:type revision: str<br>
|
|
126
|
+
:param path:<br>
|
|
127
|
+
:type path: str<br>
|
|
128
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
129
|
+
server<br>
|
|
130
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the<br>
|
|
131
|
+
server<br>
|
|
132
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPINotFoundException` if a 404 response is received from the<br>
|
|
133
|
+
server<br>
|
|
134
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIPreconditionFailedException` if a 412 response is received from<br>
|
|
135
|
+
the server<br>
|
|
136
|
+
:return: An object representing the response from the server<br>
|
|
137
|
+
:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`</tt></dd></dl>
|
|
138
|
+
|
|
139
|
+
<dl><dt><a name="ApplicationsClient-query"><strong>query</strong></a>(self) -> ai_core_sdk.models.application_query_response.ApplicationQueryResponse</dt><dd><tt>Returns the applications.<br>
|
|
140
|
+
<br>
|
|
141
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
142
|
+
server<br>
|
|
143
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the<br>
|
|
144
|
+
server<br>
|
|
145
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
146
|
+
server<br>
|
|
147
|
+
:return: The retrieved applications<br>
|
|
148
|
+
:rtype: class:`ai_core_sdk.models.application_query_response.ApplicationQueryResponse`</tt></dd></dl>
|
|
149
|
+
|
|
150
|
+
<dl><dt><a name="ApplicationsClient-refresh"><strong>refresh</strong></a>(self, application_name: str) -> ai_api_client_sdk.models.base_models.BasicResponse</dt><dd><tt>Triggers synchronisation of the application.<br>
|
|
151
|
+
<br>
|
|
152
|
+
:param application_name: name of the application to be refreshed<br>
|
|
153
|
+
:type application_name: str<br>
|
|
154
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
155
|
+
server<br>
|
|
156
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the<br>
|
|
157
|
+
server<br>
|
|
158
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPINotFoundException` if a 404 response is received from the<br>
|
|
159
|
+
server<br>
|
|
160
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIPreconditionFailedException` if a 412 response is received from<br>
|
|
161
|
+
the server<br>
|
|
162
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
163
|
+
server<br>
|
|
164
|
+
:return: An object representing the response from the server<br>
|
|
165
|
+
:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`</tt></dd></dl>
|
|
166
|
+
|
|
167
|
+
<hr>
|
|
168
|
+
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>
|
|
169
|
+
<dl><dt><a name="ApplicationsClient-__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>
|
|
170
|
+
|
|
171
|
+
<dl><dt><a name="ApplicationsClient-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>
|
|
172
|
+
|
|
173
|
+
<dl><dt><a name="ApplicationsClient-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>
|
|
174
|
+
|
|
175
|
+
<dl><dt><a name="ApplicationsClient-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>
|
|
176
|
+
|
|
177
|
+
<hr>
|
|
178
|
+
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>
|
|
179
|
+
<dl><dt><strong>__dict__</strong></dt>
|
|
180
|
+
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
181
|
+
</dl>
|
|
182
|
+
<dl><dt><strong>__weakref__</strong></dt>
|
|
183
|
+
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
184
|
+
</dl>
|
|
185
|
+
</td></tr></table></td></tr></table>
|
|
186
|
+
</body></html>
|
|
@@ -0,0 +1,147 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
2
|
+
<html><head><title>Python: module ai_core_sdk.resource_clients.docker_registry_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>.docker_registry_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/docker_registry_secrets_client.py">/home/jenkins/agent/workspace/AI-Foundation_ai-core-sdk_master/ai_core_sdk/resource_clients/docker_registry_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.docker_registry_secrets_client.html#DockerRegistrySecretsClient">DockerRegistrySecretsClient</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="DockerRegistrySecretsClient">class <strong>DockerRegistrySecretsClient</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="#DockerRegistrySecretsClient">DockerRegistrySecretsClient</a>(rest_client: ai_api_client_sdk.helpers.rest_client.RestClient)<br>
|
|
36
|
+
<br>
|
|
37
|
+
<a href="#DockerRegistrySecretsClient">DockerRegistrySecretsClient</a> is a class implemented for interacting with the docker registry 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.docker_registry_secrets_client.html#DockerRegistrySecretsClient">DockerRegistrySecretsClient</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="DockerRegistrySecretsClient-create"><strong>create</strong></a>(self, name: str, data: dict) -> ai_core_sdk.models.base_models.Message</dt><dd><tt>Creates a docker secret based on the configuration in the request body.<br>
|
|
49
|
+
<br>
|
|
50
|
+
:param name: name of the docker registry secret<br>
|
|
51
|
+
:type name: str<br>
|
|
52
|
+
:param data: json dict, defining the docker registry secret<br>
|
|
53
|
+
:type data: dict<br>
|
|
54
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
55
|
+
server<br>
|
|
56
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the<br>
|
|
57
|
+
server<br>
|
|
58
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
59
|
+
server<br>
|
|
60
|
+
:return: An object representing the response from the server<br>
|
|
61
|
+
:rtype: class:`ai_core_sdk.models.base_models.Message`</tt></dd></dl>
|
|
62
|
+
|
|
63
|
+
<dl><dt><a name="DockerRegistrySecretsClient-delete"><strong>delete</strong></a>(self, name: str) -> ai_api_client_sdk.models.base_models.BasicResponse</dt><dd><tt>Deletes the docker registry secret with the given name if it exists.<br>
|
|
64
|
+
<br>
|
|
65
|
+
:param name: name of the docker registry secret to be deleted<br>
|
|
66
|
+
:type name: str<br>
|
|
67
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
68
|
+
server<br>
|
|
69
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the<br>
|
|
70
|
+
server<br>
|
|
71
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPINotFoundException` if a 404 response is received from the<br>
|
|
72
|
+
server<br>
|
|
73
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIPreconditionFailedException` if a 412 response is received from<br>
|
|
74
|
+
the server<br>
|
|
75
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
76
|
+
server<br>
|
|
77
|
+
:return: An object representing the response from the server<br>
|
|
78
|
+
:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`</tt></dd></dl>
|
|
79
|
+
|
|
80
|
+
<dl><dt><a name="DockerRegistrySecretsClient-get"><strong>get</strong></a>(self, name: str) -> ai_core_sdk.models.docker_registry_secret.DockerRegistrySecret</dt><dd><tt>Returns the metadata of the docker registry secrets which matches the given name.<br>
|
|
81
|
+
<br>
|
|
82
|
+
:param name: name of the docker registry secret to be retrieved<br>
|
|
83
|
+
:type name: str<br>
|
|
84
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
85
|
+
server<br>
|
|
86
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the<br>
|
|
87
|
+
server<br>
|
|
88
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPINotFoundException` if a 404 response is received from the<br>
|
|
89
|
+
server<br>
|
|
90
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
91
|
+
server<br>
|
|
92
|
+
:return: The retrieved metadata of the docker registry secret<br>
|
|
93
|
+
:rtype: class:`ai_core_sdk.models.docker_registry_secret.DockerRegistrySecret`</tt></dd></dl>
|
|
94
|
+
|
|
95
|
+
<dl><dt><a name="DockerRegistrySecretsClient-modify"><strong>modify</strong></a>(self, name: str, data: dict) -> ai_api_client_sdk.models.base_models.BasicResponse</dt><dd><tt>Updates the docker registry secret<br>
|
|
96
|
+
<br>
|
|
97
|
+
:param name: name of the docker registry secret to be modified<br>
|
|
98
|
+
:type name: str<br>
|
|
99
|
+
:param data: json dict, defining the docker registry secret<br>
|
|
100
|
+
:type data: dict<br>
|
|
101
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
102
|
+
server<br>
|
|
103
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the<br>
|
|
104
|
+
server<br>
|
|
105
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPINotFoundException` if a 404 response is received from the<br>
|
|
106
|
+
server<br>
|
|
107
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIPreconditionFailedException` if a 412 response is received from<br>
|
|
108
|
+
the server<br>
|
|
109
|
+
:return: An object representing the response from the server<br>
|
|
110
|
+
:rtype: class:`ai_api_client_sdk.models.base_models.BasicResponse`</tt></dd></dl>
|
|
111
|
+
|
|
112
|
+
<dl><dt><a name="DockerRegistrySecretsClient-query"><strong>query</strong></a>(self, top: int = None, skip: int = None) -> ai_core_sdk.models.docker_registry_secret_query_response.DockerRegistrySecretQueryResponse</dt><dd><tt>Gets a list of metadata of docker registry secrets.<br>
|
|
113
|
+
<br>
|
|
114
|
+
:param top: Number of docker registry secrets to be retrieved, defaults to None<br>
|
|
115
|
+
:type top: int, optional<br>
|
|
116
|
+
:param skip: Number of docker registry secrets to be skipped, from the list of the queried docker registry<br>
|
|
117
|
+
secrets, defaults to None<br>
|
|
118
|
+
:type skip: int, optional<br>
|
|
119
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
120
|
+
server<br>
|
|
121
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the<br>
|
|
122
|
+
server<br>
|
|
123
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
124
|
+
server<br>
|
|
125
|
+
:return: A list of metadata of secrets<br>
|
|
126
|
+
:rtype: class:`ai_core_sdk.models.docker_registry_secret_query_response.DockerRegistrySecretQueryResponse`</tt></dd></dl>
|
|
127
|
+
|
|
128
|
+
<hr>
|
|
129
|
+
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>
|
|
130
|
+
<dl><dt><a name="DockerRegistrySecretsClient-__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>
|
|
131
|
+
|
|
132
|
+
<dl><dt><a name="DockerRegistrySecretsClient-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>
|
|
133
|
+
|
|
134
|
+
<dl><dt><a name="DockerRegistrySecretsClient-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>
|
|
135
|
+
|
|
136
|
+
<dl><dt><a name="DockerRegistrySecretsClient-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>
|
|
137
|
+
|
|
138
|
+
<hr>
|
|
139
|
+
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>
|
|
140
|
+
<dl><dt><strong>__dict__</strong></dt>
|
|
141
|
+
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
142
|
+
</dl>
|
|
143
|
+
<dl><dt><strong>__weakref__</strong></dt>
|
|
144
|
+
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
145
|
+
</dl>
|
|
146
|
+
</td></tr></table></td></tr></table>
|
|
147
|
+
</body></html>
|
|
@@ -0,0 +1,29 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
2
|
+
<html><head><title>Python: package ai_core_sdk.resource_clients</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>.resource_clients</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/__init__.py">/home/jenkins/agent/workspace/AI-Foundation_ai-core-sdk_master/ai_core_sdk/resource_clients/__init__.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="#aa55cc">
|
|
16
|
+
<td colspan=3 valign=bottom> <br>
|
|
17
|
+
<font color="#ffffff" face="helvetica, arial"><big><strong>Package Contents</strong></big></font></td></tr>
|
|
18
|
+
|
|
19
|
+
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
|
20
|
+
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="ai_core_sdk.resource_clients.applications_client.html">applications_client</a><br>
|
|
21
|
+
<a href="ai_core_sdk.resource_clients.docker_registry_secrets_client.html">docker_registry_secrets_client</a><br>
|
|
22
|
+
</td><td width="25%" valign=top><a href="ai_core_sdk.resource_clients.internal_rest_client.html">internal_rest_client</a><br>
|
|
23
|
+
<a href="ai_core_sdk.resource_clients.kpi_client.html">kpi_client</a><br>
|
|
24
|
+
</td><td width="25%" valign=top><a href="ai_core_sdk.resource_clients.metrics_client.html">metrics_client</a><br>
|
|
25
|
+
<a href="ai_core_sdk.resource_clients.object_store_secrets_client.html">object_store_secrets_client</a><br>
|
|
26
|
+
</td><td width="25%" valign=top><a href="ai_core_sdk.resource_clients.repositories_client.html">repositories_client</a><br>
|
|
27
|
+
<a href="ai_core_sdk.resource_clients.secrets_client.html">secrets_client</a><br>
|
|
28
|
+
</td></tr></table></td></tr></table>
|
|
29
|
+
</body></html>
|
|
@@ -0,0 +1,181 @@
|
|
|
1
|
+
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
|
|
2
|
+
<html><head><title>Python: module ai_core_sdk.resource_clients.internal_rest_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>.internal_rest_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/internal_rest_client.py">/home/jenkins/agent/workspace/AI-Foundation_ai-core-sdk_master/ai_core_sdk/resource_clients/internal_rest_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="#aa55cc">
|
|
16
|
+
<td colspan=3 valign=bottom> <br>
|
|
17
|
+
<font color="#ffffff" face="helvetica, arial"><big><strong>Modules</strong></big></font></td></tr>
|
|
18
|
+
|
|
19
|
+
<tr><td bgcolor="#aa55cc"><tt> </tt></td><td> </td>
|
|
20
|
+
<td width="100%"><table width="100%" summary="list"><tr><td width="25%" valign=top><a href="os.html">os</a><br>
|
|
21
|
+
</td><td width="25%" valign=top></td><td width="25%" valign=top></td><td width="25%" valign=top></td></tr></table></td></tr></table><p>
|
|
22
|
+
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
23
|
+
<tr bgcolor="#ee77aa">
|
|
24
|
+
<td colspan=3 valign=bottom> <br>
|
|
25
|
+
<font color="#ffffff" face="helvetica, arial"><big><strong>Classes</strong></big></font></td></tr>
|
|
26
|
+
|
|
27
|
+
<tr><td bgcolor="#ee77aa"><tt> </tt></td><td> </td>
|
|
28
|
+
<td width="100%"><dl>
|
|
29
|
+
<dt><font face="helvetica, arial"><a href="ai_api_client_sdk.helpers.rest_client.html#RestClient">ai_api_client_sdk.helpers.rest_client.RestClient</a>(<a href="builtins.html#object">builtins.object</a>)
|
|
30
|
+
</font></dt><dd>
|
|
31
|
+
<dl>
|
|
32
|
+
<dt><font face="helvetica, arial"><a href="ai_core_sdk.resource_clients.internal_rest_client.html#InternalRestClient">InternalRestClient</a>
|
|
33
|
+
</font></dt></dl>
|
|
34
|
+
</dd>
|
|
35
|
+
</dl>
|
|
36
|
+
<p>
|
|
37
|
+
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
|
|
38
|
+
<tr bgcolor="#ffc8d8">
|
|
39
|
+
<td colspan=3 valign=bottom> <br>
|
|
40
|
+
<font color="#000000" face="helvetica, arial"><a name="InternalRestClient">class <strong>InternalRestClient</strong></a>(<a href="ai_api_client_sdk.helpers.rest_client.html#RestClient">ai_api_client_sdk.helpers.rest_client.RestClient</a>)</font></td></tr>
|
|
41
|
+
|
|
42
|
+
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
|
|
43
|
+
<td colspan=2><tt><a href="#InternalRestClient">InternalRestClient</a>(base_url=None, get_token=None, resource_group=None, *args, **kwargs)<br>
|
|
44
|
+
<br>
|
|
45
|
+
<a href="#InternalRestClient">InternalRestClient</a> is a class implemented for sending requests to services within aicore. The <a href="#InternalRestClient">InternalRestClient</a> should only be used for services that do not require authentication when called within aicore.<br> </tt></td></tr>
|
|
46
|
+
<tr><td> </td>
|
|
47
|
+
<td width="100%"><dl><dt>Method resolution order:</dt>
|
|
48
|
+
<dd><a href="ai_core_sdk.resource_clients.internal_rest_client.html#InternalRestClient">InternalRestClient</a></dd>
|
|
49
|
+
<dd><a href="ai_api_client_sdk.helpers.rest_client.html#RestClient">ai_api_client_sdk.helpers.rest_client.RestClient</a></dd>
|
|
50
|
+
<dd><a href="builtins.html#object">builtins.object</a></dd>
|
|
51
|
+
</dl>
|
|
52
|
+
<hr>
|
|
53
|
+
Methods defined here:<br>
|
|
54
|
+
<dl><dt><a name="InternalRestClient-__init__"><strong>__init__</strong></a>(self, base_url=None, get_token=None, resource_group=None, *args, **kwargs)</dt><dd><tt>Initialize self. See help(type(self)) for accurate signature.</tt></dd></dl>
|
|
55
|
+
|
|
56
|
+
<hr>
|
|
57
|
+
Methods inherited from <a href="ai_api_client_sdk.helpers.rest_client.html#RestClient">ai_api_client_sdk.helpers.rest_client.RestClient</a>:<br>
|
|
58
|
+
<dl><dt><a name="InternalRestClient-delete"><strong>delete</strong></a>(self, path: str, params: Dict[str, str] = None, headers: Dict[str, str] = None, resource_group: str = None, **kwargs) -> dict</dt><dd><tt>Sends a DELETE request to the server.<br>
|
|
59
|
+
<br>
|
|
60
|
+
:param path: path of the endpoint the request should be sent to<br>
|
|
61
|
+
:type path: str<br>
|
|
62
|
+
:param params: parameters of the request, defaults to None<br>
|
|
63
|
+
:type params: Dict[str, str], optional<br>
|
|
64
|
+
:param headers: headers of the request, defaults to None<br>
|
|
65
|
+
:type headers: Dict[str, str], optional<br>
|
|
66
|
+
:param resource_group: Resource Group which the request should be sent on behalf. Either this, or the<br>
|
|
67
|
+
resource_group property of this class should be set.<br>
|
|
68
|
+
:type resource_group: str<br>
|
|
69
|
+
:param kwargs: additional keyword arguments to be passed to the request e.g. files, stream, etc.<br>
|
|
70
|
+
:type kwargs: dict<br>
|
|
71
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
72
|
+
server<br>
|
|
73
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the<br>
|
|
74
|
+
server<br>
|
|
75
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPINotFoundException` if a 404 response is received from the<br>
|
|
76
|
+
server<br>
|
|
77
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIPreconditionFailedException` if a 412 response is received from<br>
|
|
78
|
+
the server<br>
|
|
79
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
80
|
+
server<br>
|
|
81
|
+
:return: The JSON response from the server (The keys decamelized)<br>
|
|
82
|
+
:rtype: dict</tt></dd></dl>
|
|
83
|
+
|
|
84
|
+
<dl><dt><a name="InternalRestClient-get"><strong>get</strong></a>(self, path: str, params: Dict[str, str] = None, headers: Dict[str, str] = None, resource_group: str = None, return_bytes_content: bool = False, **kwargs) -> Union[dict, int]</dt><dd><tt>Sends a GET request to the server.<br>
|
|
85
|
+
<br>
|
|
86
|
+
:param path: path of the endpoint the request should be sent to<br>
|
|
87
|
+
:type path: str<br>
|
|
88
|
+
:param params: parameters of the request, defaults to None<br>
|
|
89
|
+
:type params: Dict[str, str], optional<br>
|
|
90
|
+
:param headers: headers of the request, defaults to None<br>
|
|
91
|
+
:type headers: Dict[str, str], optional<br>
|
|
92
|
+
:param resource_group: Resource Group which the request should be sent on behalf. Either this, or the<br>
|
|
93
|
+
resource_group property of this class should be set.<br>
|
|
94
|
+
:type resource_group: str<br>
|
|
95
|
+
:param return_bytes_content: expected response.content is bytes<br>
|
|
96
|
+
:type return_bytes_content: bool<br>
|
|
97
|
+
:param kwargs: additional keyword arguments to be passed to the request e.g. files, stream, etc.<br>
|
|
98
|
+
:type kwargs: dict<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.AIAPIAuthorizationException` if a 401 response is received from the<br>
|
|
102
|
+
server<br>
|
|
103
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPINotFoundException` if a 404 response is received from the<br>
|
|
104
|
+
server<br>
|
|
105
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIPreconditionFailedException` if a 412 response is received from<br>
|
|
106
|
+
the server<br>
|
|
107
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
108
|
+
server<br>
|
|
109
|
+
:return: The JSON response from the server (The keys decamelized)<br>
|
|
110
|
+
:rtype: Union[dict, int]</tt></dd></dl>
|
|
111
|
+
|
|
112
|
+
<dl><dt><a name="InternalRestClient-patch"><strong>patch</strong></a>(self, path: str, body: Dict[str, Union[str, dict, list]], headers: Dict[str, str] = None, resource_group: str = None, **kwargs) -> dict</dt><dd><tt>Sends a PATCH request to the server.<br>
|
|
113
|
+
<br>
|
|
114
|
+
:param path: path of the endpoint the request should be sent to<br>
|
|
115
|
+
:type path: str<br>
|
|
116
|
+
:param body: body of the request<br>
|
|
117
|
+
:type body: Dict[str, Union[str, dict, list]]<br>
|
|
118
|
+
:param headers: headers of the request, defaults to None<br>
|
|
119
|
+
:type headers: Dict[str, str], optional<br>
|
|
120
|
+
:param resource_group: Resource Group which the request should be sent on behalf. Either this, or the<br>
|
|
121
|
+
resource_group property of this class should be set.<br>
|
|
122
|
+
:type resource_group: str<br>
|
|
123
|
+
:param kwargs: additional keyword arguments to be passed to the request e.g. files, stream, etc.<br>
|
|
124
|
+
:type kwargs: dict<br>
|
|
125
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIInvalidRequestException` if a 400 response is received from the<br>
|
|
126
|
+
server<br>
|
|
127
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIAuthorizationException` if a 401 response is received from the<br>
|
|
128
|
+
server<br>
|
|
129
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPINotFoundException` if a 404 response is received from the<br>
|
|
130
|
+
server<br>
|
|
131
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIPreconditionFailedException` if a 412 response is received from<br>
|
|
132
|
+
the server<br>
|
|
133
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
134
|
+
server<br>
|
|
135
|
+
:return: The JSON response from the server (The keys decamelized)<br>
|
|
136
|
+
:rtype: dict</tt></dd></dl>
|
|
137
|
+
|
|
138
|
+
<dl><dt><a name="InternalRestClient-post"><strong>post</strong></a>(self, path: str, body: Dict[str, Union[str, dict]] = None, headers: Dict[str, str] = None, resource_group: str = None, **kwargs) -> dict</dt><dd><tt>Sends a POST request to the server.<br>
|
|
139
|
+
<br>
|
|
140
|
+
:param path: path of the endpoint the request should be sent to<br>
|
|
141
|
+
:type path: str<br>
|
|
142
|
+
:param body: body of the request, defaults to None<br>
|
|
143
|
+
:type body: Dict[str, str], optional<br>
|
|
144
|
+
:param headers: headers of the request, defaults to None<br>
|
|
145
|
+
:type headers: Dict[str, str], optional<br>
|
|
146
|
+
:param resource_group: Resource Group which the request should be sent on behalf. Either this, or the<br>
|
|
147
|
+
resource_group property of this class should be set.<br>
|
|
148
|
+
:type resource_group: str<br>
|
|
149
|
+
:param kwargs: additional keyword arguments to be passed to the request e.g. files, stream, etc.<br>
|
|
150
|
+
:type kwargs: dict<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.AIAPINotFoundException` if a 404 response is received from the<br>
|
|
156
|
+
server<br>
|
|
157
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIPreconditionFailedException` if a 412 response is received from<br>
|
|
158
|
+
the server<br>
|
|
159
|
+
:raises: class:`ai_api_client_sdk.exception.AIAPIServerException` if a non-2XX response is received from the<br>
|
|
160
|
+
server<br>
|
|
161
|
+
:return: The JSON response from the server (The keys decamelized)<br>
|
|
162
|
+
:rtype: dict</tt></dd></dl>
|
|
163
|
+
|
|
164
|
+
<hr>
|
|
165
|
+
Static methods inherited from <a href="ai_api_client_sdk.helpers.rest_client.html#RestClient">ai_api_client_sdk.helpers.rest_client.RestClient</a>:<br>
|
|
166
|
+
<dl><dt><a name="InternalRestClient-raise_ai_api_exception"><strong>raise_ai_api_exception</strong></a>(error_description, response, response_json)</dt></dl>
|
|
167
|
+
|
|
168
|
+
<hr>
|
|
169
|
+
Data descriptors inherited from <a href="ai_api_client_sdk.helpers.rest_client.html#RestClient">ai_api_client_sdk.helpers.rest_client.RestClient</a>:<br>
|
|
170
|
+
<dl><dt><strong>__dict__</strong></dt>
|
|
171
|
+
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
|
|
172
|
+
</dl>
|
|
173
|
+
<dl><dt><strong>__weakref__</strong></dt>
|
|
174
|
+
<dd><tt>list of weak references to the object (if defined)</tt></dd>
|
|
175
|
+
</dl>
|
|
176
|
+
<hr>
|
|
177
|
+
Data and other attributes inherited from <a href="ai_api_client_sdk.helpers.rest_client.html#RestClient">ai_api_client_sdk.helpers.rest_client.RestClient</a>:<br>
|
|
178
|
+
<dl><dt><strong>logger</strong> = <Logger ai-api-client-sdk (WARNING)></dl>
|
|
179
|
+
|
|
180
|
+
</td></tr></table></td></tr></table>
|
|
181
|
+
</body></html>
|