/ mlflow / protos / unity_catalog_oss_messages_pb2.pyi
unity_catalog_oss_messages_pb2.pyi
  1  import databricks_pb2 as _databricks_pb2
  2  from scalapb import scalapb_pb2 as _scalapb_pb2
  3  from google.protobuf.internal import containers as _containers
  4  from google.protobuf.internal import enum_type_wrapper as _enum_type_wrapper
  5  from google.protobuf import descriptor as _descriptor
  6  from google.protobuf import message as _message
  7  from typing import ClassVar as _ClassVar, Iterable as _Iterable, Mapping as _Mapping, Optional as _Optional, Union as _Union
  8  
  9  DESCRIPTOR: _descriptor.FileDescriptor
 10  
 11  class ModelVersionStatus(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
 12      __slots__ = ()
 13      MODEL_VERSION_STATUS_UNKNOWN: _ClassVar[ModelVersionStatus]
 14      PENDING_REGISTRATION: _ClassVar[ModelVersionStatus]
 15      FAILED_REGISTRATION: _ClassVar[ModelVersionStatus]
 16      READY: _ClassVar[ModelVersionStatus]
 17  
 18  class ModelVersionOperation(int, metaclass=_enum_type_wrapper.EnumTypeWrapper):
 19      __slots__ = ()
 20      UNKNOWN_MODEL_VERSION_OPERATION: _ClassVar[ModelVersionOperation]
 21      READ_MODEL_VERSION: _ClassVar[ModelVersionOperation]
 22      READ_WRITE_MODEL_VERSION: _ClassVar[ModelVersionOperation]
 23  MODEL_VERSION_STATUS_UNKNOWN: ModelVersionStatus
 24  PENDING_REGISTRATION: ModelVersionStatus
 25  FAILED_REGISTRATION: ModelVersionStatus
 26  READY: ModelVersionStatus
 27  UNKNOWN_MODEL_VERSION_OPERATION: ModelVersionOperation
 28  READ_MODEL_VERSION: ModelVersionOperation
 29  READ_WRITE_MODEL_VERSION: ModelVersionOperation
 30  
 31  class RegisteredModelInfo(_message.Message):
 32      __slots__ = ("name", "catalog_name", "schema_name", "comment", "storage_location", "full_name", "created_at", "created_by", "updated_at", "updated_by", "id", "browse_only")
 33      NAME_FIELD_NUMBER: _ClassVar[int]
 34      CATALOG_NAME_FIELD_NUMBER: _ClassVar[int]
 35      SCHEMA_NAME_FIELD_NUMBER: _ClassVar[int]
 36      COMMENT_FIELD_NUMBER: _ClassVar[int]
 37      STORAGE_LOCATION_FIELD_NUMBER: _ClassVar[int]
 38      FULL_NAME_FIELD_NUMBER: _ClassVar[int]
 39      CREATED_AT_FIELD_NUMBER: _ClassVar[int]
 40      CREATED_BY_FIELD_NUMBER: _ClassVar[int]
 41      UPDATED_AT_FIELD_NUMBER: _ClassVar[int]
 42      UPDATED_BY_FIELD_NUMBER: _ClassVar[int]
 43      ID_FIELD_NUMBER: _ClassVar[int]
 44      BROWSE_ONLY_FIELD_NUMBER: _ClassVar[int]
 45      name: str
 46      catalog_name: str
 47      schema_name: str
 48      comment: str
 49      storage_location: str
 50      full_name: str
 51      created_at: int
 52      created_by: str
 53      updated_at: int
 54      updated_by: str
 55      id: str
 56      browse_only: bool
 57      def __init__(self, name: _Optional[str] = ..., catalog_name: _Optional[str] = ..., schema_name: _Optional[str] = ..., comment: _Optional[str] = ..., storage_location: _Optional[str] = ..., full_name: _Optional[str] = ..., created_at: _Optional[int] = ..., created_by: _Optional[str] = ..., updated_at: _Optional[int] = ..., updated_by: _Optional[str] = ..., id: _Optional[str] = ..., browse_only: bool = ...) -> None: ...
 58  
 59  class CreateRegisteredModel(_message.Message):
 60      __slots__ = ("name", "catalog_name", "schema_name", "comment", "storage_location")
 61      class Response(_message.Message):
 62          __slots__ = ("registered_model_info",)
 63          REGISTERED_MODEL_INFO_FIELD_NUMBER: _ClassVar[int]
 64          registered_model_info: RegisteredModelInfo
 65          def __init__(self, registered_model_info: _Optional[_Union[RegisteredModelInfo, _Mapping]] = ...) -> None: ...
 66      NAME_FIELD_NUMBER: _ClassVar[int]
 67      CATALOG_NAME_FIELD_NUMBER: _ClassVar[int]
 68      SCHEMA_NAME_FIELD_NUMBER: _ClassVar[int]
 69      COMMENT_FIELD_NUMBER: _ClassVar[int]
 70      STORAGE_LOCATION_FIELD_NUMBER: _ClassVar[int]
 71      name: str
 72      catalog_name: str
 73      schema_name: str
 74      comment: str
 75      storage_location: str
 76      def __init__(self, name: _Optional[str] = ..., catalog_name: _Optional[str] = ..., schema_name: _Optional[str] = ..., comment: _Optional[str] = ..., storage_location: _Optional[str] = ...) -> None: ...
 77  
 78  class DeleteRegisteredModel(_message.Message):
 79      __slots__ = ("full_name", "force")
 80      class Response(_message.Message):
 81          __slots__ = ()
 82          def __init__(self) -> None: ...
 83      FULL_NAME_FIELD_NUMBER: _ClassVar[int]
 84      FORCE_FIELD_NUMBER: _ClassVar[int]
 85      full_name: str
 86      force: bool
 87      def __init__(self, full_name: _Optional[str] = ..., force: bool = ...) -> None: ...
 88  
 89  class GetRegisteredModel(_message.Message):
 90      __slots__ = ("full_name",)
 91      class Response(_message.Message):
 92          __slots__ = ("registered_model_info",)
 93          REGISTERED_MODEL_INFO_FIELD_NUMBER: _ClassVar[int]
 94          registered_model_info: RegisteredModelInfo
 95          def __init__(self, registered_model_info: _Optional[_Union[RegisteredModelInfo, _Mapping]] = ...) -> None: ...
 96      FULL_NAME_FIELD_NUMBER: _ClassVar[int]
 97      full_name: str
 98      def __init__(self, full_name: _Optional[str] = ...) -> None: ...
 99  
100  class UpdateRegisteredModel(_message.Message):
101      __slots__ = ("full_name", "new_name", "comment")
102      class Response(_message.Message):
103          __slots__ = ("registered_model_info",)
104          REGISTERED_MODEL_INFO_FIELD_NUMBER: _ClassVar[int]
105          registered_model_info: RegisteredModelInfo
106          def __init__(self, registered_model_info: _Optional[_Union[RegisteredModelInfo, _Mapping]] = ...) -> None: ...
107      FULL_NAME_FIELD_NUMBER: _ClassVar[int]
108      NEW_NAME_FIELD_NUMBER: _ClassVar[int]
109      COMMENT_FIELD_NUMBER: _ClassVar[int]
110      full_name: str
111      new_name: str
112      comment: str
113      def __init__(self, full_name: _Optional[str] = ..., new_name: _Optional[str] = ..., comment: _Optional[str] = ...) -> None: ...
114  
115  class ListRegisteredModels(_message.Message):
116      __slots__ = ("catalog_name", "schema_name", "max_results", "page_token")
117      class Response(_message.Message):
118          __slots__ = ("registered_models", "next_page_token")
119          REGISTERED_MODELS_FIELD_NUMBER: _ClassVar[int]
120          NEXT_PAGE_TOKEN_FIELD_NUMBER: _ClassVar[int]
121          registered_models: _containers.RepeatedCompositeFieldContainer[RegisteredModelInfo]
122          next_page_token: str
123          def __init__(self, registered_models: _Optional[_Iterable[_Union[RegisteredModelInfo, _Mapping]]] = ..., next_page_token: _Optional[str] = ...) -> None: ...
124      CATALOG_NAME_FIELD_NUMBER: _ClassVar[int]
125      SCHEMA_NAME_FIELD_NUMBER: _ClassVar[int]
126      MAX_RESULTS_FIELD_NUMBER: _ClassVar[int]
127      PAGE_TOKEN_FIELD_NUMBER: _ClassVar[int]
128      catalog_name: str
129      schema_name: str
130      max_results: int
131      page_token: str
132      def __init__(self, catalog_name: _Optional[str] = ..., schema_name: _Optional[str] = ..., max_results: _Optional[int] = ..., page_token: _Optional[str] = ...) -> None: ...
133  
134  class ModelVersionInfo(_message.Message):
135      __slots__ = ("model_name", "catalog_name", "schema_name", "source", "comment", "run_id", "status", "version", "storage_location", "created_at", "created_by", "updated_at", "updated_by", "id")
136      MODEL_NAME_FIELD_NUMBER: _ClassVar[int]
137      CATALOG_NAME_FIELD_NUMBER: _ClassVar[int]
138      SCHEMA_NAME_FIELD_NUMBER: _ClassVar[int]
139      SOURCE_FIELD_NUMBER: _ClassVar[int]
140      COMMENT_FIELD_NUMBER: _ClassVar[int]
141      RUN_ID_FIELD_NUMBER: _ClassVar[int]
142      STATUS_FIELD_NUMBER: _ClassVar[int]
143      VERSION_FIELD_NUMBER: _ClassVar[int]
144      STORAGE_LOCATION_FIELD_NUMBER: _ClassVar[int]
145      CREATED_AT_FIELD_NUMBER: _ClassVar[int]
146      CREATED_BY_FIELD_NUMBER: _ClassVar[int]
147      UPDATED_AT_FIELD_NUMBER: _ClassVar[int]
148      UPDATED_BY_FIELD_NUMBER: _ClassVar[int]
149      ID_FIELD_NUMBER: _ClassVar[int]
150      model_name: str
151      catalog_name: str
152      schema_name: str
153      source: str
154      comment: str
155      run_id: str
156      status: ModelVersionStatus
157      version: int
158      storage_location: str
159      created_at: int
160      created_by: str
161      updated_at: int
162      updated_by: str
163      id: str
164      def __init__(self, model_name: _Optional[str] = ..., catalog_name: _Optional[str] = ..., schema_name: _Optional[str] = ..., source: _Optional[str] = ..., comment: _Optional[str] = ..., run_id: _Optional[str] = ..., status: _Optional[_Union[ModelVersionStatus, str]] = ..., version: _Optional[int] = ..., storage_location: _Optional[str] = ..., created_at: _Optional[int] = ..., created_by: _Optional[str] = ..., updated_at: _Optional[int] = ..., updated_by: _Optional[str] = ..., id: _Optional[str] = ...) -> None: ...
165  
166  class CreateModelVersion(_message.Message):
167      __slots__ = ("model_name", "catalog_name", "schema_name", "source", "run_id", "comment")
168      class Response(_message.Message):
169          __slots__ = ("model_version_info",)
170          MODEL_VERSION_INFO_FIELD_NUMBER: _ClassVar[int]
171          model_version_info: ModelVersionInfo
172          def __init__(self, model_version_info: _Optional[_Union[ModelVersionInfo, _Mapping]] = ...) -> None: ...
173      MODEL_NAME_FIELD_NUMBER: _ClassVar[int]
174      CATALOG_NAME_FIELD_NUMBER: _ClassVar[int]
175      SCHEMA_NAME_FIELD_NUMBER: _ClassVar[int]
176      SOURCE_FIELD_NUMBER: _ClassVar[int]
177      RUN_ID_FIELD_NUMBER: _ClassVar[int]
178      COMMENT_FIELD_NUMBER: _ClassVar[int]
179      model_name: str
180      catalog_name: str
181      schema_name: str
182      source: str
183      run_id: str
184      comment: str
185      def __init__(self, model_name: _Optional[str] = ..., catalog_name: _Optional[str] = ..., schema_name: _Optional[str] = ..., source: _Optional[str] = ..., run_id: _Optional[str] = ..., comment: _Optional[str] = ...) -> None: ...
186  
187  class DeleteModelVersion(_message.Message):
188      __slots__ = ("full_name", "version")
189      class Response(_message.Message):
190          __slots__ = ()
191          def __init__(self) -> None: ...
192      FULL_NAME_FIELD_NUMBER: _ClassVar[int]
193      VERSION_FIELD_NUMBER: _ClassVar[int]
194      full_name: str
195      version: int
196      def __init__(self, full_name: _Optional[str] = ..., version: _Optional[int] = ...) -> None: ...
197  
198  class FinalizeModelVersion(_message.Message):
199      __slots__ = ("full_name", "version")
200      class Response(_message.Message):
201          __slots__ = ("model_version_info",)
202          MODEL_VERSION_INFO_FIELD_NUMBER: _ClassVar[int]
203          model_version_info: ModelVersionInfo
204          def __init__(self, model_version_info: _Optional[_Union[ModelVersionInfo, _Mapping]] = ...) -> None: ...
205      FULL_NAME_FIELD_NUMBER: _ClassVar[int]
206      VERSION_FIELD_NUMBER: _ClassVar[int]
207      full_name: str
208      version: int
209      def __init__(self, full_name: _Optional[str] = ..., version: _Optional[int] = ...) -> None: ...
210  
211  class GetModelVersion(_message.Message):
212      __slots__ = ("full_name", "version")
213      class Response(_message.Message):
214          __slots__ = ("model_version_info",)
215          MODEL_VERSION_INFO_FIELD_NUMBER: _ClassVar[int]
216          model_version_info: ModelVersionInfo
217          def __init__(self, model_version_info: _Optional[_Union[ModelVersionInfo, _Mapping]] = ...) -> None: ...
218      FULL_NAME_FIELD_NUMBER: _ClassVar[int]
219      VERSION_FIELD_NUMBER: _ClassVar[int]
220      full_name: str
221      version: int
222      def __init__(self, full_name: _Optional[str] = ..., version: _Optional[int] = ...) -> None: ...
223  
224  class UpdateModelVersion(_message.Message):
225      __slots__ = ("full_name", "version", "comment")
226      class Response(_message.Message):
227          __slots__ = ("model_version_info",)
228          MODEL_VERSION_INFO_FIELD_NUMBER: _ClassVar[int]
229          model_version_info: ModelVersionInfo
230          def __init__(self, model_version_info: _Optional[_Union[ModelVersionInfo, _Mapping]] = ...) -> None: ...
231      FULL_NAME_FIELD_NUMBER: _ClassVar[int]
232      VERSION_FIELD_NUMBER: _ClassVar[int]
233      COMMENT_FIELD_NUMBER: _ClassVar[int]
234      full_name: str
235      version: int
236      comment: str
237      def __init__(self, full_name: _Optional[str] = ..., version: _Optional[int] = ..., comment: _Optional[str] = ...) -> None: ...
238  
239  class ListModelVersions(_message.Message):
240      __slots__ = ("full_name", "max_results", "page_token")
241      class Response(_message.Message):
242          __slots__ = ("model_versions", "next_page_token")
243          MODEL_VERSIONS_FIELD_NUMBER: _ClassVar[int]
244          NEXT_PAGE_TOKEN_FIELD_NUMBER: _ClassVar[int]
245          model_versions: _containers.RepeatedCompositeFieldContainer[ModelVersionInfo]
246          next_page_token: str
247          def __init__(self, model_versions: _Optional[_Iterable[_Union[ModelVersionInfo, _Mapping]]] = ..., next_page_token: _Optional[str] = ...) -> None: ...
248      FULL_NAME_FIELD_NUMBER: _ClassVar[int]
249      MAX_RESULTS_FIELD_NUMBER: _ClassVar[int]
250      PAGE_TOKEN_FIELD_NUMBER: _ClassVar[int]
251      full_name: str
252      max_results: int
253      page_token: str
254      def __init__(self, full_name: _Optional[str] = ..., max_results: _Optional[int] = ..., page_token: _Optional[str] = ...) -> None: ...
255  
256  class TemporaryCredentials(_message.Message):
257      __slots__ = ("aws_temp_credentials", "azure_user_delegation_sas", "gcp_oauth_token", "expiration_time")
258      AWS_TEMP_CREDENTIALS_FIELD_NUMBER: _ClassVar[int]
259      AZURE_USER_DELEGATION_SAS_FIELD_NUMBER: _ClassVar[int]
260      GCP_OAUTH_TOKEN_FIELD_NUMBER: _ClassVar[int]
261      EXPIRATION_TIME_FIELD_NUMBER: _ClassVar[int]
262      aws_temp_credentials: AwsCredentials
263      azure_user_delegation_sas: AzureUserDelegationSAS
264      gcp_oauth_token: GcpOauthToken
265      expiration_time: int
266      def __init__(self, aws_temp_credentials: _Optional[_Union[AwsCredentials, _Mapping]] = ..., azure_user_delegation_sas: _Optional[_Union[AzureUserDelegationSAS, _Mapping]] = ..., gcp_oauth_token: _Optional[_Union[GcpOauthToken, _Mapping]] = ..., expiration_time: _Optional[int] = ...) -> None: ...
267  
268  class AwsCredentials(_message.Message):
269      __slots__ = ("access_key_id", "secret_access_key", "session_token")
270      ACCESS_KEY_ID_FIELD_NUMBER: _ClassVar[int]
271      SECRET_ACCESS_KEY_FIELD_NUMBER: _ClassVar[int]
272      SESSION_TOKEN_FIELD_NUMBER: _ClassVar[int]
273      access_key_id: str
274      secret_access_key: str
275      session_token: str
276      def __init__(self, access_key_id: _Optional[str] = ..., secret_access_key: _Optional[str] = ..., session_token: _Optional[str] = ...) -> None: ...
277  
278  class AzureUserDelegationSAS(_message.Message):
279      __slots__ = ("sas_token",)
280      SAS_TOKEN_FIELD_NUMBER: _ClassVar[int]
281      sas_token: str
282      def __init__(self, sas_token: _Optional[str] = ...) -> None: ...
283  
284  class GcpOauthToken(_message.Message):
285      __slots__ = ("oauth_token",)
286      OAUTH_TOKEN_FIELD_NUMBER: _ClassVar[int]
287      oauth_token: str
288      def __init__(self, oauth_token: _Optional[str] = ...) -> None: ...
289  
290  class GenerateTemporaryModelVersionCredential(_message.Message):
291      __slots__ = ("catalog_name", "schema_name", "model_name", "version", "operation")
292      class Response(_message.Message):
293          __slots__ = ("credentials",)
294          CREDENTIALS_FIELD_NUMBER: _ClassVar[int]
295          credentials: TemporaryCredentials
296          def __init__(self, credentials: _Optional[_Union[TemporaryCredentials, _Mapping]] = ...) -> None: ...
297      CATALOG_NAME_FIELD_NUMBER: _ClassVar[int]
298      SCHEMA_NAME_FIELD_NUMBER: _ClassVar[int]
299      MODEL_NAME_FIELD_NUMBER: _ClassVar[int]
300      VERSION_FIELD_NUMBER: _ClassVar[int]
301      OPERATION_FIELD_NUMBER: _ClassVar[int]
302      catalog_name: str
303      schema_name: str
304      model_name: str
305      version: int
306      operation: ModelVersionOperation
307      def __init__(self, catalog_name: _Optional[str] = ..., schema_name: _Optional[str] = ..., model_name: _Optional[str] = ..., version: _Optional[int] = ..., operation: _Optional[_Union[ModelVersionOperation, str]] = ...) -> None: ...