Services
RPC methods exposed by this API.RemoteFileService
| Method | Request | Response | Description |
|---|---|---|---|
| GetRemoteFile | GetRemoteFileRequest | GetRemoteFileResponse | Retrieve a remote file. |
| CreateRemoteFile | CreateRemoteFileRequest | CreateRemoteFileResponse | Create a remote file. Note that this does not perform the actual file upload. |
| 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. |
Messages
Data models used across requests/responses.AudioMetadata
| Field | Type | Label | Description |
|---|---|---|---|
| duration_seconds | float | ||
| timestamp | google.protobuf.Timestamp |
BatchDeleteRemoteFilesRequest
The request for a call toRemoteFileService_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 toRemoteFileService_BatchDeleteRemoteFiles.
This message has no fields.
CreateRemoteFileRequest
The request for a call toRemoteFileService_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. | |
| oneof metadata. video_metadata | VideoMetadata | ||
| oneof metadata. image_metadata | ImageMetadata | ||
| oneof metadata. audio_metadata | AudioMetadata | ||
| custom_uuid | string | optional | A custom UUID used to generate the object key. Recommended to be left unset. |
| metadata_values | sift.metadata.v1.MetadataValue | repeated | The metadata values associated with this remote file. |
CreateRemoteFileResponse
The response for a call toRemoteFileService_CreateRemoteFile.
| Field | Type | Label | Description |
|---|---|---|---|
| remote_file | RemoteFile |
DeleteRemoteFileRequest
The request for a call toRemoteFileService_DeleteRemoteFile to delete a remote file.
| Field | Type | Label | Description |
|---|---|---|---|
| remote_file_id | string |
DeleteRemoteFileResponse
The response of a call toRemoteFileService_DeleteRemoteFile.
This message has no fields.
GetRemoteFileDownloadUrlRequest
The request for a call toRemoteFileService_GetRemoteFileDownloadUrl.
| Field | Type | Label | Description |
|---|---|---|---|
| remote_file_id | string |
GetRemoteFileDownloadUrlResponse
The response of a call toRemoteFileService_GetRemoteFileDownloadUrl.
| Field | Type | Label | Description |
|---|---|---|---|
| download_url | string |
GetRemoteFileRequest
The request for a call toRemoteFileService_GetRemoteFile to retrieve a remote file;
| Field | Type | Label | Description |
|---|---|---|---|
| remote_file_id | string |
GetRemoteFileResponse
The response of a call toRemoteFileService_GetRemoteFile.
| Field | Type | Label | Description |
|---|---|---|---|
| remote_file | RemoteFile |
ImageMetadata
| Field | Type | Label | Description |
|---|---|---|---|
| height | uint32 | ||
| width | uint32 |
ListRemoteFilesRequest
The request for a call toRemoteFileService_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, metadata, 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. | |
| order_by | string | How to order the retrieved reports. Formatted as a comma-separated string i.e. “FIELD_NAME[ desc],…”. Available fields to order_by are name, created_date and modified_date. If left empty, items are ordered by created_date in descending order (newest-first). For more information about the format of this field, read this Example: “created_date desc,modified_date” |
ListRemoteFilesResponse
The response of a call toRemoteFileService_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 | |
| oneof metadata. video_metadata | VideoMetadata | ||
| oneof metadata. image_metadata | ImageMetadata | ||
| oneof metadata. audio_metadata | AudioMetadata | ||
| created_by_user_id | string | ||
| modified_by_user_id | string | ||
| created_date | google.protobuf.Timestamp | ||
| modified_date | google.protobuf.Timestamp | ||
| metadata_values | sift.metadata.v1.MetadataValue | repeated |
UpdateRemoteFileRequest
The request for a call toRemoteFileService_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, metadata_values, and metadata. |
UpdateRemoteFileResponse
The response of a call toRemoteFileService_UpdateRemoteFile.
| Field | Type | Label | Description |
|---|---|---|---|
| remote_file | RemoteFile |
VideoMetadata
| Field | Type | Label | Description |
|---|---|---|---|
| height | uint32 | ||
| width | uint32 | ||
| duration_seconds | float | ||
| timestamp | google.protobuf.Timestamp |
Enums
Allowed constant values used in message fields.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 | |
| ENTITY_TYPE_TEST_REPORT | 5 |