FileDownloadHeaders interface

Pakiet:

@azure/storage-file-share

Definiuje nagłówki dla operacji File_download.

Właściwości

acceptRanges	Wskazuje, że usługa obsługuje żądania częściowej zawartości pliku.
cacheControl	Zwrócony, jeśli został wcześniej określony dla pliku.
contentDisposition	Zwraca wartość określoną dla nagłówka "x-ms-content-disposition" i określa sposób przetwarzania odpowiedzi.
contentEncoding	Zwraca wartość określoną dla nagłówka żądania Content-Encoding.
contentLanguage	Zwraca wartość określoną dla nagłówka żądania Content-Language.
contentLength	Liczba bajtów obecnych w treści odpowiedzi.
contentMD5	Jeśli plik ma skrót MD5 i żądanie jest odczytanie pełnego pliku, ten nagłówek odpowiedzi jest zwracany, aby klient mógł sprawdzić integralność zawartości wiadomości. Jeśli żądanie ma odczytać określony zakres, a wartość "x-ms-range-get-content-md5" ma wartość true, żądanie zwraca skrót MD5 dla zakresu, o ile rozmiar zakresu jest mniejszy lub równy 4 MB. Jeśli żaden z tych zestawów warunków nie jest spełniony, dla nagłówka "Content-MD5" nie jest zwracana żadna wartość.
contentRange	Wskazuje zakres bajtów zwracanych, jeśli klient zażądał podzestawu pliku, ustawiając nagłówek żądania zakresu.
contentType	Typ zawartości określony dla pliku. Domyślny typ zawartości to "application/octet-stream"
copyCompletedOn	Czas ostatniej próby skopiowania pliku, w którym ten plik był plikiem docelowym. Ta wartość może określać czas ukończenia, przerwania lub nieudanej próby kopiowania.
copyId	Identyfikator ciągu dla ostatniej próby operacji kopiowania pliku, gdzie ten plik był plikiem docelowym.
copyProgress	Zawiera liczbę skopiowanych bajtów oraz łączną liczbę bajtów w źródle podczas ostatniej próby operacji kopiowania pliku, w której ten plik był plikiem docelowym. Może pokazywać skopiowane bajty z zakresu od 0 do długości zawartości.
copySource	Adres URL o długości do 2 KB, który określa plik źródłowy używany podczas ostatniej próby operacji kopiowania pliku, gdzie ten plik był plikiem docelowym.
copyStatus	Stan operacji kopiowania zidentyfikowany przez polecenie "x-ms-copy-id".
copyStatusDescription	Pojawia się tylko wtedy, gdy stan x-ms-copy-status to niepowodzenie lub oczekiwanie. Opisuje przyczynę niepowodzenia operacji kopiowania krytycznego lub niekrytycznego.
date	Wartość daty/godziny UTC wygenerowana przez usługę, która wskazuje godzinę, o której zainicjowano odpowiedź.
errorCode	Kod błędu
etag	Element ETag zawiera wartość, której można użyć do warunkowego wykonywania operacji w cudzysłowie.
fileAttributes	Atrybuty ustawione dla pliku.
fileChangeOn	Zmień czas dla pliku.
fileContentMD5	Jeśli plik ma skrót MD5 i jeśli żądanie zawiera nagłówek zakresu (Zakres lub x-ms-range), ten nagłówek odpowiedzi jest zwracany z wartością wartości MD5 całego pliku. Ta wartość może lub nie może być równa wartości zwracanej w nagłówku Content-MD5, a ta ostatnia jest obliczana z żądanego zakresu.
fileCreatedOn	Czas utworzenia pliku.
fileId	FileId pliku.
fileLastWriteOn	Czas ostatniego zapisu dla pliku.
fileParentId	Identyfikator pliku nadrzędnego.
filePermissionKey	Klucz zestawu uprawnień dla pliku.
isServerEncrypted	Wartość tego nagłówka jest ustawiona na wartość true, jeśli dane pliku i metadane aplikacji są całkowicie szyfrowane przy użyciu określonego algorytmu. W przeciwnym razie wartość jest ustawiona na false (gdy plik jest niezaszyfrowany lub jeśli zaszyfrowane są tylko części metadanych pliku/aplikacji).
lastModified	Zwraca datę i godzinę ostatniej modyfikacji pliku. Każda operacja modyfikując plik lub jego właściwości aktualizuje czas ostatniej modyfikacji.
leaseDuration	Gdy plik jest dzierżawiony, określa, czy dzierżawa ma nieskończony, czy stały czas trwania.
leaseState	Stan dzierżawy pliku.
leaseStatus	Bieżący stan dzierżawy pliku.
metadata	Zestaw par nazwa-wartość skojarzonych z tym plikiem jako metadanych zdefiniowanych przez użytkownika.
requestId	Ten nagłówek jednoznacznie identyfikuje żądanie, które zostało wykonane i może służyć do rozwiązywania problemów z żądaniem.
version	Wskazuje wersję usługi plików używaną do wykonania żądania.

Szczegóły właściwości

acceptRanges

Wskazuje, że usługa obsługuje żądania częściowej zawartości pliku.

acceptRanges?: string

Wartość właściwości

string

cacheControl

Zwrócony, jeśli został wcześniej określony dla pliku.

cacheControl?: string

Wartość właściwości

string

contentDisposition

Zwraca wartość określoną dla nagłówka "x-ms-content-disposition" i określa sposób przetwarzania odpowiedzi.

contentDisposition?: string

Wartość właściwości

string

contentEncoding

Zwraca wartość określoną dla nagłówka żądania Content-Encoding.

contentEncoding?: string

Wartość właściwości

string

contentLanguage

Zwraca wartość określoną dla nagłówka żądania Content-Language.

contentLanguage?: string

Wartość właściwości

string

contentLength

Liczba bajtów obecnych w treści odpowiedzi.

contentLength?: number

Wartość właściwości

number

contentMD5

Jeśli plik ma skrót MD5 i żądanie jest odczytanie pełnego pliku, ten nagłówek odpowiedzi jest zwracany, aby klient mógł sprawdzić integralność zawartości wiadomości. Jeśli żądanie ma odczytać określony zakres, a wartość "x-ms-range-get-content-md5" ma wartość true, żądanie zwraca skrót MD5 dla zakresu, o ile rozmiar zakresu jest mniejszy lub równy 4 MB. Jeśli żaden z tych zestawów warunków nie jest spełniony, dla nagłówka "Content-MD5" nie jest zwracana żadna wartość.

contentMD5?: Uint8Array

Wartość właściwości

Uint8Array

contentRange

Wskazuje zakres bajtów zwracanych, jeśli klient zażądał podzestawu pliku, ustawiając nagłówek żądania zakresu.

contentRange?: string

Wartość właściwości

string

contentType

Typ zawartości określony dla pliku. Domyślny typ zawartości to "application/octet-stream"

contentType?: string

Wartość właściwości

string

copyCompletedOn

Czas ostatniej próby skopiowania pliku, w którym ten plik był plikiem docelowym. Ta wartość może określać czas ukończenia, przerwania lub nieudanej próby kopiowania.

copyCompletedOn?: Date

Wartość właściwości

Date

copyId

Identyfikator ciągu dla ostatniej próby operacji kopiowania pliku, gdzie ten plik był plikiem docelowym.

copyId?: string

Wartość właściwości

string

copyProgress

Zawiera liczbę skopiowanych bajtów oraz łączną liczbę bajtów w źródle podczas ostatniej próby operacji kopiowania pliku, w której ten plik był plikiem docelowym. Może pokazywać skopiowane bajty z zakresu od 0 do długości zawartości.

copyProgress?: string

Wartość właściwości

string

copySource

Adres URL o długości do 2 KB, który określa plik źródłowy używany podczas ostatniej próby operacji kopiowania pliku, gdzie ten plik był plikiem docelowym.

copySource?: string

Wartość właściwości

string

copyStatus

Stan operacji kopiowania zidentyfikowany przez polecenie "x-ms-copy-id".

copyStatus?: CopyStatusType

Wartość właściwości

CopyStatusType

copyStatusDescription

Pojawia się tylko wtedy, gdy stan x-ms-copy-status to niepowodzenie lub oczekiwanie. Opisuje przyczynę niepowodzenia operacji kopiowania krytycznego lub niekrytycznego.

copyStatusDescription?: string

Wartość właściwości

string

date

Wartość daty/godziny UTC wygenerowana przez usługę, która wskazuje godzinę, o której zainicjowano odpowiedź.

date?: Date

Wartość właściwości

Date

errorCode

Kod błędu

errorCode?: string

Wartość właściwości

string

etag

Element ETag zawiera wartość, której można użyć do warunkowego wykonywania operacji w cudzysłowie.

etag?: string

Wartość właściwości

string

fileAttributes

Atrybuty ustawione dla pliku.

fileAttributes?: string

Wartość właściwości

string

fileChangeOn

Zmień czas dla pliku.

fileChangeOn?: Date

Wartość właściwości

Date

fileContentMD5

Jeśli plik ma skrót MD5 i jeśli żądanie zawiera nagłówek zakresu (Zakres lub x-ms-range), ten nagłówek odpowiedzi jest zwracany z wartością wartości MD5 całego pliku. Ta wartość może lub nie może być równa wartości zwracanej w nagłówku Content-MD5, a ta ostatnia jest obliczana z żądanego zakresu.

fileContentMD5?: Uint8Array

Wartość właściwości

Uint8Array

fileCreatedOn

Czas utworzenia pliku.

fileCreatedOn?: Date

Wartość właściwości

Date

fileId

FileId pliku.

fileId?: string

Wartość właściwości

string

fileLastWriteOn

Czas ostatniego zapisu dla pliku.

fileLastWriteOn?: Date

Wartość właściwości

Date

fileParentId

Identyfikator pliku nadrzędnego.

fileParentId?: string

Wartość właściwości

string

filePermissionKey

Klucz zestawu uprawnień dla pliku.

filePermissionKey?: string

Wartość właściwości

string

isServerEncrypted

Wartość tego nagłówka jest ustawiona na wartość true, jeśli dane pliku i metadane aplikacji są całkowicie szyfrowane przy użyciu określonego algorytmu. W przeciwnym razie wartość jest ustawiona na false (gdy plik jest niezaszyfrowany lub jeśli zaszyfrowane są tylko części metadanych pliku/aplikacji).

isServerEncrypted?: boolean

Wartość właściwości

boolean

lastModified

Zwraca datę i godzinę ostatniej modyfikacji pliku. Każda operacja modyfikując plik lub jego właściwości aktualizuje czas ostatniej modyfikacji.

lastModified?: Date

Wartość właściwości

Date

leaseDuration

Gdy plik jest dzierżawiony, określa, czy dzierżawa ma nieskończony, czy stały czas trwania.

leaseDuration?: LeaseDurationType

Wartość właściwości

LeaseDurationType

leaseState

Stan dzierżawy pliku.

leaseState?: LeaseStateType

Wartość właściwości

LeaseStateType

leaseStatus

Bieżący stan dzierżawy pliku.

leaseStatus?: LeaseStatusType

Wartość właściwości

LeaseStatusType

metadata

Zestaw par nazwa-wartość skojarzonych z tym plikiem jako metadanych zdefiniowanych przez użytkownika.

metadata?: {[propertyName: string]: string}

Wartość właściwości

{[propertyName: string]: string}

requestId

Ten nagłówek jednoznacznie identyfikuje żądanie, które zostało wykonane i może służyć do rozwiązywania problemów z żądaniem.

requestId?: string

Wartość właściwości

string

version

Wskazuje wersję usługi plików używaną do wykonania żądania.

version?: string

Wartość właściwości

string