remote_files
Protocol buffer definition for remote_files
sift/remote_files/v1/remote_files.proto
AudioMetadata
Field | Type | Label | Description |
---|---|---|---|
duration_seconds | float | ||
timestamp | google.protobuf.Timestamp |
BatchDeleteRemoteFilesRequest
The request for a call to RemoteFileService_BatchDeleteRemoteFiles
to delete remote files.
Field | Type | Label | Description |
---|---|---|---|
remote_file_ids | string | repeated | Up to 1000 remote file IDs can be provided per request. |
BatchDeleteRemoteFilesResponse
The response of a call to RemoteFileService_BatchDeleteRemoteFiles
.
CreateRemoteFileRequest
The request for a call to RemoteFileService_CreateRemoteFile
to create a remote file.
Field | Type | Label | Description |
---|---|---|---|
file_name | string | ||
entity_id | string | ||
entity_type | EntityType | ||
file_mime_type | string | ||
file_content_encoding | string | ||
file_size | uint64 | ||
description | string | optional | |
organization_id | string | This field is only required if your user belongs to multiple organizations. | |
video_metadata | VideoMetadata | ||
image_metadata | ImageMetadata | ||
audio_metadata | AudioMetadata | ||
custom_uuid | string | optional | A custom UUID used to generate the object key. Recommended to be left unset. |
CreateRemoteFileResponse
The response for a call to RemoteFileService_CreateRemoteFile
.
Field | Type | Label | Description |
---|---|---|---|
remote_file | RemoteFile |
DeleteRemoteFileRequest
The request for a call to RemoteFileService_DeleteRemoteFile
to delete a remote file.
Field | Type | Label | Description |
---|---|---|---|
remote_file_id | string |
DeleteRemoteFileResponse
The response of a call to RemoteFileService_DeleteRemoteFile
.
GetRemoteFileDownloadUrlRequest
The request for a call to RemoteFileService_GetRemoteFileDownloadUrl
.
Field | Type | Label | Description |
---|---|---|---|
remote_file_id | string |
GetRemoteFileDownloadUrlResponse
The response of a call to RemoteFileService_GetRemoteFileDownloadUrl
.
Field | Type | Label | Description |
---|---|---|---|
download_url | string |
GetRemoteFileRequest
The request for a call to RemoteFileService_GetRemoteFile
to retrieve a remote file;
Field | Type | Label | Description |
---|---|---|---|
remote_file_id | string |
GetRemoteFileResponse
The response of a call to RemoteFileService_GetRemoteFile
.
Field | Type | Label | Description |
---|---|---|---|
remote_file | RemoteFile |
ImageMetadata
ListRemoteFilesRequest
The request for a call to RemoteFileService_ListRemoteFiles
to retrieve remote files.
Field | Type | Label | Description |
---|---|---|---|
page_size | uint32 | 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 | string | 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 | string | A Common Expression Language (CEL) 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. For more information about the fields used for filtering, please refer to this definition. Optional. | |
organization_id | string | This field is only required if your user belongs to multiple organizations. |
ListRemoteFilesResponse
The response of a call to RemoteFileService_ListRemoteFilesResponse
.
Field | Type | Label | Description |
---|---|---|---|
remote_files | RemoteFile | repeated | |
next_page_token | string |
RemoteFile
Field | Type | Label | Description |
---|---|---|---|
remote_file_id | string | ||
organization_id | string | ||
entity_id | string | ||
entity_type | EntityType | ||
file_name | string | ||
file_mime_type | string | ||
file_content_encoding | string | ||
storage_key | string | ||
file_size | uint64 | ||
description | string | optional | |
video_metadata | VideoMetadata | ||
image_metadata | ImageMetadata | ||
audio_metadata | AudioMetadata | ||
created_by_user_id | string | ||
modified_by_user_id | string | ||
created_date | google.protobuf.Timestamp | ||
modified_date | google.protobuf.Timestamp |
UpdateRemoteFileRequest
The request for a call to RemoteFileService_UpdateRemoteFile
to update a remote file.
Field | Type | Label | Description |
---|---|---|---|
remote_file | RemoteFile | The remote file to update. | |
update_mask | google.protobuf.FieldMask | The list of fields to be updated. The fields available to be updated are description and metadata . |
UpdateRemoteFileResponse
The response of a call to RemoteFileService_UpdateRemoteFile
.
Field | Type | Label | Description |
---|---|---|---|
remote_file | RemoteFile |
VideoMetadata
Field | Type | Label | Description |
---|---|---|---|
height | uint32 | ||
width | uint32 | ||
duration_seconds | float | ||
timestamp | google.protobuf.Timestamp |
EntityType
Name | Number | Description |
---|---|---|
ENTITY_TYPE_UNSPECIFIED | 0 | |
ENTITY_TYPE_RUN | 1 | |
ENTITY_TYPE_ANNOTATION | 2 | |
ENTITY_TYPE_ASSET | 3 | |
ENTITY_TYPE_ANNOTATION_LOG | 4 |
RemoteFileService
Method Name | Request Type | Response Type | Description |
---|---|---|---|
GetRemoteFile | GetRemoteFileRequest | GetRemoteFileResponse | Retrieve a remote file. |
CreateRemoteFile | CreateRemoteFileRequest | CreateRemoteFileResponse | Create a remote file. |
ListRemoteFiles | ListRemoteFilesRequest | ListRemoteFilesResponse | List remote files. |
UpdateRemoteFile | UpdateRemoteFileRequest | UpdateRemoteFileResponse | Updates an existing remote file using using the list of fields specified in update_mask . |
DeleteRemoteFile | DeleteRemoteFileRequest | DeleteRemoteFileResponse | Delete a remote file. |
BatchDeleteRemoteFiles | BatchDeleteRemoteFilesRequest | BatchDeleteRemoteFilesResponse | Batch deletes remote files. Each batch is limited to 1000 records. |
GetRemoteFileDownloadUrl | GetRemoteFileDownloadUrlRequest | GetRemoteFileDownloadUrlResponse | Gets a download URL for the remote file. |