FileGetPropertiesHeaders interface

Пакет:

@azure/storage-file

Определяет заголовки для операции GetProperties.

Свойства

cacheControl	Если заголовок запроса Cache-Control ранее был задан для файла, значение Cache-Control возвращается в этом заголовке.
contentDisposition	Возвращает значение, указанное для заголовка x-ms-content-disposition, и указывает, как обрабатывать ответ.
contentEncoding	Если заголовок запроса на кодировку содержимого ранее был задан для файла, значение кодирования содержимого возвращается в этом заголовке.
contentLanguage	Возвращает значение, указанное для заголовка запроса Content-Language.
contentLength	Размер файла в байтах. Этот заголовок возвращает значение заголовка x-ms-content-length, хранящегося в файле.
contentMD5	Если для файла задан заголовок Content-MD5, возвращается заголовок ответа Content-MD5, чтобы клиент смог проверить целостность содержимого сообщения.
contentType	Тип контента, указанный для файла. Тип контента по умолчанию — application/octet-stream.
copyCompletionTime	Время завершения последней попытки копирования файла, в которой этот файл был целевым файлом. Это значение может указать время завершения, прерывания или неудачной попытки копирования.
copyId	Строковый идентификатор для последней попытки копирования файла, в которой этот файл был целевым файлом.
copyProgress	Содержит количество скопированных байтов и общее количество байтов в источнике в последней попытке копировать файл, где этот файл был целевым файлом. Может отображаться от 0 до байтов содержимого, скопированных.
copySource	URL-адрес длиной до 2 КБ, указывающий исходный файл, используемый в последней попытке копировать файл, где этот файл был целевым файлом.
copyStatus	Состояние операции копирования, определяемой x-ms-copy-id. Возможные значения включают: "ожидание", "успешно", "прервано", "неудачно"
copyStatusDescription	Отображается только при сбое или ожидании состояния x-ms-copy-copy. Описывает причину сбоя неустранимая или неустранимая операция копирования.
date	Значение даты и времени в формате UTC, созданное службой, указывающее время, в течение которого был инициирован ответ.
errorCode
eTag	ETag содержит значение, которое можно использовать для условного выполнения операций в кавычках.
fileAttributes	Атрибуты, заданные для файла.
fileChangeTime	Изменение времени для файла.
fileCreationTime	Время создания файла.
fileId	FileId файла.
fileLastWriteTime	Время последней записи для файла.
fileParentId	Родительский идентификатор файла.
filePermissionKey	Ключ набора разрешений для файла.
fileType	Возвращает тип File. Зарезервировано для дальнейшего использования. Возможные значения: "Файл"
isServerEncrypted	Значение этого заголовка имеет значение true, если данные файла и метаданные приложения полностью шифруются с помощью указанного алгоритма. В противном случае значение имеет значение false (если файл незашифрован или если шифруются только части метаданных файла или приложения).
lastModified	Возвращает дату и время последнего изменения файла. Формат даты следует RFC 1123. Любая операция, которая изменяет файл или его свойства, обновляет время последнего изменения.
metadata
requestId	Этот заголовок однозначно идентифицирует выполненный запрос и может использоваться для устранения неполадок запроса.
version	Указывает версию службы файлов, используемую для выполнения запроса.

Сведения о свойстве

cacheControl

Если заголовок запроса Cache-Control ранее был задан для файла, значение Cache-Control возвращается в этом заголовке.

cacheControl?: undefined | string

Значение свойства

undefined | string

contentDisposition

Возвращает значение, указанное для заголовка x-ms-content-disposition, и указывает, как обрабатывать ответ.

contentDisposition?: undefined | string

Значение свойства

undefined | string

contentEncoding

Если заголовок запроса на кодировку содержимого ранее был задан для файла, значение кодирования содержимого возвращается в этом заголовке.

contentEncoding?: undefined | string

Значение свойства

undefined | string

contentLanguage

Возвращает значение, указанное для заголовка запроса Content-Language.

contentLanguage?: undefined | string

Значение свойства

undefined | string

contentLength

Размер файла в байтах. Этот заголовок возвращает значение заголовка x-ms-content-length, хранящегося в файле.

contentLength?: undefined | number

Значение свойства

undefined | number

contentMD5

Если для файла задан заголовок Content-MD5, возвращается заголовок ответа Content-MD5, чтобы клиент смог проверить целостность содержимого сообщения.

contentMD5?: Uint8Array

Значение свойства

Uint8Array

contentType

Тип контента, указанный для файла. Тип контента по умолчанию — application/octet-stream.

contentType?: undefined | string

Значение свойства

undefined | string

copyCompletionTime

Время завершения последней попытки копирования файла, в которой этот файл был целевым файлом. Это значение может указать время завершения, прерывания или неудачной попытки копирования.

copyCompletionTime?: Date

Значение свойства

Date

copyId

Строковый идентификатор для последней попытки копирования файла, в которой этот файл был целевым файлом.

copyId?: undefined | string

Значение свойства

undefined | string

copyProgress

Содержит количество скопированных байтов и общее количество байтов в источнике в последней попытке копировать файл, где этот файл был целевым файлом. Может отображаться от 0 до байтов содержимого, скопированных.

copyProgress?: undefined | string

Значение свойства

undefined | string

copySource

URL-адрес длиной до 2 КБ, указывающий исходный файл, используемый в последней попытке копировать файл, где этот файл был целевым файлом.

copySource?: undefined | string

Значение свойства

undefined | string

copyStatus

Состояние операции копирования, определяемой x-ms-copy-id. Возможные значения включают: "ожидание", "успешно", "прервано", "неудачно"

copyStatus?: CopyStatusType

Значение свойства

CopyStatusType

copyStatusDescription

Отображается только при сбое или ожидании состояния x-ms-copy-copy. Описывает причину сбоя неустранимая или неустранимая операция копирования.

copyStatusDescription?: undefined | string

Значение свойства

undefined | string

date

Значение даты и времени в формате UTC, созданное службой, указывающее время, в течение которого был инициирован ответ.

date?: Date

Значение свойства

Date

errorCode

errorCode?: undefined | string

Значение свойства

undefined | string

eTag

ETag содержит значение, которое можно использовать для условного выполнения операций в кавычках.

eTag?: undefined | string

Значение свойства

undefined | string

fileAttributes

Атрибуты, заданные для файла.

fileAttributes?: undefined | string

Значение свойства

undefined | string

fileChangeTime

Изменение времени для файла.

fileChangeTime?: Date

Значение свойства

Date

fileCreationTime

Время создания файла.

fileCreationTime?: Date

Значение свойства

Date

fileId

FileId файла.

fileId?: undefined | string

Значение свойства

undefined | string

fileLastWriteTime

Время последней записи для файла.

fileLastWriteTime?: Date

Значение свойства

Date

fileParentId

Родительский идентификатор файла.

fileParentId?: undefined | string

Значение свойства

undefined | string

filePermissionKey

Ключ набора разрешений для файла.

filePermissionKey?: undefined | string

Значение свойства

undefined | string

fileType

Возвращает тип File. Зарезервировано для дальнейшего использования. Возможные значения: "Файл"

fileType?: FileType

Значение свойства

FileType

isServerEncrypted

Значение этого заголовка имеет значение true, если данные файла и метаданные приложения полностью шифруются с помощью указанного алгоритма. В противном случае значение имеет значение false (если файл незашифрован или если шифруются только части метаданных файла или приложения).

isServerEncrypted?: undefined | false | true

Значение свойства

undefined | false | true

lastModified

Возвращает дату и время последнего изменения файла. Формат даты следует RFC 1123. Любая операция, которая изменяет файл или его свойства, обновляет время последнего изменения.

lastModified?: Date

Значение свойства

Date

metadata

metadata?: undefined | [key: string]: string

Значение свойства

undefined | [key: string]: string

requestId

Этот заголовок однозначно идентифицирует выполненный запрос и может использоваться для устранения неполадок запроса.

requestId?: undefined | string

Значение свойства

undefined | string

version

Указывает версию службы файлов, используемую для выполнения запроса.

version?: undefined | string

Значение свойства

undefined | string