remote_files

Protocol buffer definition for remote_files

sift/remote_files/v1/remote_files.proto

BatchDeleteRemoteFilesRequest

The request for a call to RemoteFileService_BatchDeleteRemoteFiles to delete remote files.

FieldTypeLabelDescription
remote_file_idsstringrepeatedUp 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.

FieldTypeLabelDescription
file_namestring
entity_idstring
entity_typeEntityType
file_mime_typestring
file_content_encodingstring
file_sizeuint64
descriptionstringoptional
organization_idstringThis field is only required if your user belongs to multiple organizations.
video_metadataVideoMetadata
image_metadataImageMetadata
custom_uuidstringoptionalA custom UUID used to generate the object key. Recommended to be left unset.

CreateRemoteFileResponse

The response for a call to RemoteFileService_CreateRemoteFile.

FieldTypeLabelDescription
remote_fileRemoteFile

DeleteRemoteFileRequest

The request for a call to RemoteFileService_DeleteRemoteFile to delete a remote file.

FieldTypeLabelDescription
remote_file_idstring

DeleteRemoteFileResponse

The response of a call to RemoteFileService_DeleteRemoteFile.

GetRemoteFileDownloadUrlRequest

The request for a call to RemoteFileService_GetRemoteFileDownloadUrl.

FieldTypeLabelDescription
remote_file_idstring

GetRemoteFileDownloadUrlResponse

The response of a call to RemoteFileService_GetRemoteFileDownloadUrl.

FieldTypeLabelDescription
download_urlstring

GetRemoteFileRequest

The request for a call to RemoteFileService_GetRemoteFile to retrieve a remote file;

FieldTypeLabelDescription
remote_file_idstring

GetRemoteFileResponse

The response of a call to RemoteFileService_GetRemoteFile.

FieldTypeLabelDescription
remote_fileRemoteFile

ImageMetadata

FieldTypeLabelDescription
heightuint32
widthuint32

ListRemoteFilesRequest

The request for a call to RemoteFileService_ListRemoteFiles to retrieve remote files.

FieldTypeLabelDescription
page_sizeuint32The 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_tokenstringA 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.
filterstringA 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_idstringThis field is only required if your user belongs to multiple organizations.

ListRemoteFilesResponse

The response of a call to RemoteFileService_ListRemoteFilesResponse.

FieldTypeLabelDescription
remote_filesRemoteFilerepeated
next_page_tokenstring

RemoteFile

FieldTypeLabelDescription
remote_file_idstring
organization_idstring
entity_idstring
entity_typeEntityType
file_namestring
file_mime_typestring
file_content_encodingstring
storage_keystring
file_sizeuint64
descriptionstringoptional
video_metadataVideoMetadata
image_metadataImageMetadata
created_by_user_idstring
modified_by_user_idstring
created_dategoogle.protobuf.Timestamp
modified_dategoogle.protobuf.Timestamp

UpdateRemoteFileRequest

The request for a call to RemoteFileService_UpdateRemoteFile to update a remote file.

FieldTypeLabelDescription
remote_fileRemoteFileThe remote file to update.
update_maskgoogle.protobuf.FieldMaskThe 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.

FieldTypeLabelDescription
remote_fileRemoteFile

VideoMetadata

FieldTypeLabelDescription
heightuint32
widthuint32
duration_secondsfloat
timestampgoogle.protobuf.Timestamp

EntityType

NameNumberDescription
ENTITY_TYPE_UNSPECIFIED0
ENTITY_TYPE_RUN1
ENTITY_TYPE_ANNOTATION2
ENTITY_TYPE_ASSET3
ENTITY_TYPE_ANNOTATION_LOG4

RemoteFileService

Method NameRequest TypeResponse TypeDescription
GetRemoteFileGetRemoteFileRequestGetRemoteFileResponseRetrieve a remote file.
CreateRemoteFileCreateRemoteFileRequestCreateRemoteFileResponseCreate a remote file.
ListRemoteFilesListRemoteFilesRequestListRemoteFilesResponseList remote files.
UpdateRemoteFileUpdateRemoteFileRequestUpdateRemoteFileResponseUpdates an existing remote file using using the list of fields specified in update_mask.
DeleteRemoteFileDeleteRemoteFileRequestDeleteRemoteFileResponseDelete a remote file.
BatchDeleteRemoteFilesBatchDeleteRemoteFilesRequestBatchDeleteRemoteFilesResponseBatch deletes remote files. Each batch is limited to 1000 records.
GetRemoteFileDownloadUrlGetRemoteFileDownloadUrlRequestGetRemoteFileDownloadUrlResponseGets a download URL for the remote file.

On this page