sift-stack-py 0.3.2__py3-none-any.whl

sift/remote_files/v1/remote_files_pb2.pyi

@@ -0,0 +1,472 @@
+"""
+@generated by mypy-protobuf.  Do not edit manually!
+isort:skip_file
+"""
+
+import builtins
+import collections.abc
+import google.protobuf.descriptor
+import google.protobuf.field_mask_pb2
+import google.protobuf.internal.containers
+import google.protobuf.internal.enum_type_wrapper
+import google.protobuf.message
+import google.protobuf.timestamp_pb2
+import sys
+import typing
+
+if sys.version_info >= (3, 10):
+    import typing as typing_extensions
+else:
+    import typing_extensions
+
+DESCRIPTOR: google.protobuf.descriptor.FileDescriptor
+
+class _EntityType:
+    ValueType = typing.NewType("ValueType", builtins.int)
+    V: typing_extensions.TypeAlias = ValueType
+
+class _EntityTypeEnumTypeWrapper(google.protobuf.internal.enum_type_wrapper._EnumTypeWrapper[_EntityType.ValueType], builtins.type):
+    DESCRIPTOR: google.protobuf.descriptor.EnumDescriptor
+    ENTITY_TYPE_UNSPECIFIED: _EntityType.ValueType  # 0
+    ENTITY_TYPE_RUN: _EntityType.ValueType  # 1
+    ENTITY_TYPE_ANNOTATION: _EntityType.ValueType  # 2
+    ENTITY_TYPE_ASSET: _EntityType.ValueType  # 3
+    ENTITY_TYPE_ANNOTATION_LOG: _EntityType.ValueType  # 4
+
+class EntityType(_EntityType, metaclass=_EntityTypeEnumTypeWrapper): ...
+
+ENTITY_TYPE_UNSPECIFIED: EntityType.ValueType  # 0
+ENTITY_TYPE_RUN: EntityType.ValueType  # 1
+ENTITY_TYPE_ANNOTATION: EntityType.ValueType  # 2
+ENTITY_TYPE_ASSET: EntityType.ValueType  # 3
+ENTITY_TYPE_ANNOTATION_LOG: EntityType.ValueType  # 4
+global___EntityType = EntityType
+
+@typing.final
+class RemoteFile(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    REMOTE_FILE_ID_FIELD_NUMBER: builtins.int
+    ORGANIZATION_ID_FIELD_NUMBER: builtins.int
+    ENTITY_ID_FIELD_NUMBER: builtins.int
+    ENTITY_TYPE_FIELD_NUMBER: builtins.int
+    FILE_NAME_FIELD_NUMBER: builtins.int
+    FILE_MIME_TYPE_FIELD_NUMBER: builtins.int
+    FILE_CONTENT_ENCODING_FIELD_NUMBER: builtins.int
+    STORAGE_KEY_FIELD_NUMBER: builtins.int
+    FILE_SIZE_FIELD_NUMBER: builtins.int
+    DESCRIPTION_FIELD_NUMBER: builtins.int
+    VIDEO_METADATA_FIELD_NUMBER: builtins.int
+    IMAGE_METADATA_FIELD_NUMBER: builtins.int
+    CREATED_BY_USER_ID_FIELD_NUMBER: builtins.int
+    MODIFIED_BY_USER_ID_FIELD_NUMBER: builtins.int
+    CREATED_DATE_FIELD_NUMBER: builtins.int
+    MODIFIED_DATE_FIELD_NUMBER: builtins.int
+    remote_file_id: builtins.str
+    organization_id: builtins.str
+    entity_id: builtins.str
+    entity_type: global___EntityType.ValueType
+    file_name: builtins.str
+    file_mime_type: builtins.str
+    file_content_encoding: builtins.str
+    storage_key: builtins.str
+    file_size: builtins.int
+    description: builtins.str
+    created_by_user_id: builtins.str
+    modified_by_user_id: builtins.str
+    @property
+    def video_metadata(self) -> global___VideoMetadata: ...
+    @property
+    def image_metadata(self) -> global___ImageMetadata: ...
+    @property
+    def created_date(self) -> google.protobuf.timestamp_pb2.Timestamp: ...
+    @property
+    def modified_date(self) -> google.protobuf.timestamp_pb2.Timestamp: ...
+    def __init__(
+        self,
+        *,
+        remote_file_id: builtins.str = ...,
+        organization_id: builtins.str = ...,
+        entity_id: builtins.str = ...,
+        entity_type: global___EntityType.ValueType = ...,
+        file_name: builtins.str = ...,
+        file_mime_type: builtins.str = ...,
+        file_content_encoding: builtins.str = ...,
+        storage_key: builtins.str = ...,
+        file_size: builtins.int = ...,
+        description: builtins.str | None = ...,
+        video_metadata: global___VideoMetadata | None = ...,
+        image_metadata: global___ImageMetadata | None = ...,
+        created_by_user_id: builtins.str = ...,
+        modified_by_user_id: builtins.str = ...,
+        created_date: google.protobuf.timestamp_pb2.Timestamp | None = ...,
+        modified_date: google.protobuf.timestamp_pb2.Timestamp | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["_description", b"_description", "created_date", b"created_date", "description", b"description", "image_metadata", b"image_metadata", "metadata", b"metadata", "modified_date", b"modified_date", "video_metadata", b"video_metadata"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["_description", b"_description", "created_by_user_id", b"created_by_user_id", "created_date", b"created_date", "description", b"description", "entity_id", b"entity_id", "entity_type", b"entity_type", "file_content_encoding", b"file_content_encoding", "file_mime_type", b"file_mime_type", "file_name", b"file_name", "file_size", b"file_size", "image_metadata", b"image_metadata", "metadata", b"metadata", "modified_by_user_id", b"modified_by_user_id", "modified_date", b"modified_date", "organization_id", b"organization_id", "remote_file_id", b"remote_file_id", "storage_key", b"storage_key", "video_metadata", b"video_metadata"]) -> None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal["_description", b"_description"]) -> typing.Literal["description"] | None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal["metadata", b"metadata"]) -> typing.Literal["video_metadata", "image_metadata"] | None: ...
+
+global___RemoteFile = RemoteFile
+
+@typing.final
+class VideoMetadata(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    HEIGHT_FIELD_NUMBER: builtins.int
+    WIDTH_FIELD_NUMBER: builtins.int
+    DURATION_SECONDS_FIELD_NUMBER: builtins.int
+    TIMESTAMP_FIELD_NUMBER: builtins.int
+    height: builtins.int
+    width: builtins.int
+    duration_seconds: builtins.float
+    @property
+    def timestamp(self) -> google.protobuf.timestamp_pb2.Timestamp: ...
+    def __init__(
+        self,
+        *,
+        height: builtins.int = ...,
+        width: builtins.int = ...,
+        duration_seconds: builtins.float = ...,
+        timestamp: google.protobuf.timestamp_pb2.Timestamp | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["timestamp", b"timestamp"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["duration_seconds", b"duration_seconds", "height", b"height", "timestamp", b"timestamp", "width", b"width"]) -> None: ...
+
+global___VideoMetadata = VideoMetadata
+
+@typing.final
+class ImageMetadata(google.protobuf.message.Message):
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    HEIGHT_FIELD_NUMBER: builtins.int
+    WIDTH_FIELD_NUMBER: builtins.int
+    height: builtins.int
+    width: builtins.int
+    def __init__(
+        self,
+        *,
+        height: builtins.int = ...,
+        width: builtins.int = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["height", b"height", "width", b"width"]) -> None: ...
+
+global___ImageMetadata = ImageMetadata
+
+@typing.final
+class GetRemoteFileRequest(google.protobuf.message.Message):
+    """The request for a call to `RemoteFileService_GetRemoteFile` to retrieve a remote file;"""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    REMOTE_FILE_ID_FIELD_NUMBER: builtins.int
+    remote_file_id: builtins.str
+    def __init__(
+        self,
+        *,
+        remote_file_id: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["remote_file_id", b"remote_file_id"]) -> None: ...
+
+global___GetRemoteFileRequest = GetRemoteFileRequest
+
+@typing.final
+class GetRemoteFileResponse(google.protobuf.message.Message):
+    """The response of a call to `RemoteFileService_GetRemoteFile`."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    REMOTE_FILE_FIELD_NUMBER: builtins.int
+    @property
+    def remote_file(self) -> global___RemoteFile: ...
+    def __init__(
+        self,
+        *,
+        remote_file: global___RemoteFile | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["remote_file", b"remote_file"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["remote_file", b"remote_file"]) -> None: ...
+
+global___GetRemoteFileResponse = GetRemoteFileResponse
+
+@typing.final
+class ListRemoteFilesRequest(google.protobuf.message.Message):
+    """The request for a call to `RemoteFileService_ListRemoteFiles` to retrieve remote files."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    PAGE_SIZE_FIELD_NUMBER: builtins.int
+    PAGE_TOKEN_FIELD_NUMBER: builtins.int
+    FILTER_FIELD_NUMBER: builtins.int
+    ORGANIZATION_ID_FIELD_NUMBER: builtins.int
+    page_size: builtins.int
+    """The maximum number of remote files to return. The service may return fewer than this value.
+    If unspecified, at most 50 remote files will be returned. The maximum value is 1000; values above
+    1000 will be coerced to 1000. Optional.
+    """
+    page_token: builtins.str
+    """A page token, received from a previous `ListRemoteFiles` call.
+    Provide this to retrieve the subsequent page.
+    When paginating, all other parameters provided to `ListRemoteFiles` must match
+    the call that provided the page token. Optional.
+    """
+    filter: builtins.str
+    """A [Common Expression Language (CEL)](https://github.com/google/cel-spec) filter string.
+    Available fields to filter by are `remote_file_id`, `entity_id`, `entity_type`, and `file_name`.
+    For further information about how to use CELs, please refer to [this guide](https://github.com/google/cel-spec/blob/master/doc/langdef.md#standard-definitions).
+    For more information about the fields used for filtering, please refer to [this definition](/api/grpc/protocol_buffers/remote_files#remotefile). Optional.
+    """
+    organization_id: builtins.str
+    """This field is only required if your user belongs to multiple organizations."""
+    def __init__(
+        self,
+        *,
+        page_size: builtins.int = ...,
+        page_token: builtins.str = ...,
+        filter: builtins.str = ...,
+        organization_id: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["filter", b"filter", "organization_id", b"organization_id", "page_size", b"page_size", "page_token", b"page_token"]) -> None: ...
+
+global___ListRemoteFilesRequest = ListRemoteFilesRequest
+
+@typing.final
+class ListRemoteFilesResponse(google.protobuf.message.Message):
+    """The response of a call to `RemoteFileService_ListRemoteFilesResponse`."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    REMOTE_FILES_FIELD_NUMBER: builtins.int
+    NEXT_PAGE_TOKEN_FIELD_NUMBER: builtins.int
+    next_page_token: builtins.str
+    @property
+    def remote_files(self) -> google.protobuf.internal.containers.RepeatedCompositeFieldContainer[global___RemoteFile]: ...
+    def __init__(
+        self,
+        *,
+        remote_files: collections.abc.Iterable[global___RemoteFile] | None = ...,
+        next_page_token: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["next_page_token", b"next_page_token", "remote_files", b"remote_files"]) -> None: ...
+
+global___ListRemoteFilesResponse = ListRemoteFilesResponse
+
+@typing.final
+class CreateRemoteFileRequest(google.protobuf.message.Message):
+    """The request for a call to `RemoteFileService_CreateRemoteFile` to create a remote file."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    FILE_NAME_FIELD_NUMBER: builtins.int
+    ENTITY_ID_FIELD_NUMBER: builtins.int
+    ENTITY_TYPE_FIELD_NUMBER: builtins.int
+    FILE_MIME_TYPE_FIELD_NUMBER: builtins.int
+    FILE_CONTENT_ENCODING_FIELD_NUMBER: builtins.int
+    FILE_SIZE_FIELD_NUMBER: builtins.int
+    DESCRIPTION_FIELD_NUMBER: builtins.int
+    ORGANIZATION_ID_FIELD_NUMBER: builtins.int
+    VIDEO_METADATA_FIELD_NUMBER: builtins.int
+    IMAGE_METADATA_FIELD_NUMBER: builtins.int
+    CUSTOM_UUID_FIELD_NUMBER: builtins.int
+    file_name: builtins.str
+    entity_id: builtins.str
+    entity_type: global___EntityType.ValueType
+    file_mime_type: builtins.str
+    file_content_encoding: builtins.str
+    file_size: builtins.int
+    description: builtins.str
+    organization_id: builtins.str
+    """This field is only required if your user belongs to multiple organizations."""
+    custom_uuid: builtins.str
+    """A custom UUID used to generate the object key. Recommended to be left unset."""
+    @property
+    def video_metadata(self) -> global___VideoMetadata: ...
+    @property
+    def image_metadata(self) -> global___ImageMetadata: ...
+    def __init__(
+        self,
+        *,
+        file_name: builtins.str = ...,
+        entity_id: builtins.str = ...,
+        entity_type: global___EntityType.ValueType = ...,
+        file_mime_type: builtins.str = ...,
+        file_content_encoding: builtins.str = ...,
+        file_size: builtins.int = ...,
+        description: builtins.str | None = ...,
+        organization_id: builtins.str = ...,
+        video_metadata: global___VideoMetadata | None = ...,
+        image_metadata: global___ImageMetadata | None = ...,
+        custom_uuid: builtins.str | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["_custom_uuid", b"_custom_uuid", "_description", b"_description", "custom_uuid", b"custom_uuid", "description", b"description", "image_metadata", b"image_metadata", "metadata", b"metadata", "video_metadata", b"video_metadata"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["_custom_uuid", b"_custom_uuid", "_description", b"_description", "custom_uuid", b"custom_uuid", "description", b"description", "entity_id", b"entity_id", "entity_type", b"entity_type", "file_content_encoding", b"file_content_encoding", "file_mime_type", b"file_mime_type", "file_name", b"file_name", "file_size", b"file_size", "image_metadata", b"image_metadata", "metadata", b"metadata", "organization_id", b"organization_id", "video_metadata", b"video_metadata"]) -> None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal["_custom_uuid", b"_custom_uuid"]) -> typing.Literal["custom_uuid"] | None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal["_description", b"_description"]) -> typing.Literal["description"] | None: ...
+    @typing.overload
+    def WhichOneof(self, oneof_group: typing.Literal["metadata", b"metadata"]) -> typing.Literal["video_metadata", "image_metadata"] | None: ...
+
+global___CreateRemoteFileRequest = CreateRemoteFileRequest
+
+@typing.final
+class CreateRemoteFileResponse(google.protobuf.message.Message):
+    """The response for a call to `RemoteFileService_CreateRemoteFile`."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    REMOTE_FILE_FIELD_NUMBER: builtins.int
+    @property
+    def remote_file(self) -> global___RemoteFile: ...
+    def __init__(
+        self,
+        *,
+        remote_file: global___RemoteFile | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["remote_file", b"remote_file"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["remote_file", b"remote_file"]) -> None: ...
+
+global___CreateRemoteFileResponse = CreateRemoteFileResponse
+
+@typing.final
+class DeleteRemoteFileRequest(google.protobuf.message.Message):
+    """The request for a call to `RemoteFileService_DeleteRemoteFile` to delete a remote file."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    REMOTE_FILE_ID_FIELD_NUMBER: builtins.int
+    remote_file_id: builtins.str
+    def __init__(
+        self,
+        *,
+        remote_file_id: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["remote_file_id", b"remote_file_id"]) -> None: ...
+
+global___DeleteRemoteFileRequest = DeleteRemoteFileRequest
+
+@typing.final
+class DeleteRemoteFileResponse(google.protobuf.message.Message):
+    """The response of a call to `RemoteFileService_DeleteRemoteFile`."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    def __init__(
+        self,
+    ) -> None: ...
+
+global___DeleteRemoteFileResponse = DeleteRemoteFileResponse
+
+@typing.final
+class BatchDeleteRemoteFilesRequest(google.protobuf.message.Message):
+    """The request for a call to `RemoteFileService_BatchDeleteRemoteFiles` to delete remote files."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    REMOTE_FILE_IDS_FIELD_NUMBER: builtins.int
+    @property
+    def remote_file_ids(self) -> google.protobuf.internal.containers.RepeatedScalarFieldContainer[builtins.str]:
+        """Up to 1000 remote file IDs can be provided per request."""
+
+    def __init__(
+        self,
+        *,
+        remote_file_ids: collections.abc.Iterable[builtins.str] | None = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["remote_file_ids", b"remote_file_ids"]) -> None: ...
+
+global___BatchDeleteRemoteFilesRequest = BatchDeleteRemoteFilesRequest
+
+@typing.final
+class BatchDeleteRemoteFilesResponse(google.protobuf.message.Message):
+    """The response of a call to `RemoteFileService_BatchDeleteRemoteFiles`."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    def __init__(
+        self,
+    ) -> None: ...
+
+global___BatchDeleteRemoteFilesResponse = BatchDeleteRemoteFilesResponse
+
+@typing.final
+class UpdateRemoteFileRequest(google.protobuf.message.Message):
+    """The request for a call to `RemoteFileService_UpdateRemoteFile` to update a remote file."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    REMOTE_FILE_FIELD_NUMBER: builtins.int
+    UPDATE_MASK_FIELD_NUMBER: builtins.int
+    @property
+    def remote_file(self) -> global___RemoteFile:
+        """The remote file to update."""
+
+    @property
+    def update_mask(self) -> google.protobuf.field_mask_pb2.FieldMask:
+        """The list of fields to be updated. The fields available to be updated are `description` and `metadata`."""
+
+    def __init__(
+        self,
+        *,
+        remote_file: global___RemoteFile | None = ...,
+        update_mask: google.protobuf.field_mask_pb2.FieldMask | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["remote_file", b"remote_file", "update_mask", b"update_mask"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["remote_file", b"remote_file", "update_mask", b"update_mask"]) -> None: ...
+
+global___UpdateRemoteFileRequest = UpdateRemoteFileRequest
+
+@typing.final
+class UpdateRemoteFileResponse(google.protobuf.message.Message):
+    """The response of a call to `RemoteFileService_UpdateRemoteFile`."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    REMOTE_FILE_FIELD_NUMBER: builtins.int
+    @property
+    def remote_file(self) -> global___RemoteFile: ...
+    def __init__(
+        self,
+        *,
+        remote_file: global___RemoteFile | None = ...,
+    ) -> None: ...
+    def HasField(self, field_name: typing.Literal["remote_file", b"remote_file"]) -> builtins.bool: ...
+    def ClearField(self, field_name: typing.Literal["remote_file", b"remote_file"]) -> None: ...
+
+global___UpdateRemoteFileResponse = UpdateRemoteFileResponse
+
+@typing.final
+class GetRemoteFileDownloadUrlRequest(google.protobuf.message.Message):
+    """The request for a call to `RemoteFileService_GetRemoteFileDownloadUrl`."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    REMOTE_FILE_ID_FIELD_NUMBER: builtins.int
+    remote_file_id: builtins.str
+    def __init__(
+        self,
+        *,
+        remote_file_id: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["remote_file_id", b"remote_file_id"]) -> None: ...
+
+global___GetRemoteFileDownloadUrlRequest = GetRemoteFileDownloadUrlRequest
+
+@typing.final
+class GetRemoteFileDownloadUrlResponse(google.protobuf.message.Message):
+    """The response of a call to `RemoteFileService_GetRemoteFileDownloadUrl`."""
+
+    DESCRIPTOR: google.protobuf.descriptor.Descriptor
+
+    DOWNLOAD_URL_FIELD_NUMBER: builtins.int
+    download_url: builtins.str
+    def __init__(
+        self,
+        *,
+        download_url: builtins.str = ...,
+    ) -> None: ...
+    def ClearField(self, field_name: typing.Literal["download_url", b"download_url"]) -> None: ...
+
+global___GetRemoteFileDownloadUrlResponse = GetRemoteFileDownloadUrlResponse