FileGetPropertiesHeaders interface

Pakiet:

@azure/storage-file-share

Definiuje nagłówki dla operacji File_getProperties.

Właściwości

cacheControl	Jeśli nagłówek żądania Cache-Control został wcześniej ustawiony dla pliku, wartość Cache-Control zostanie zwrócona w tym nagłówku.
contentDisposition	Zwraca wartość, która została określona dla nagłówka "x-ms-content-disposition" i określa sposób przetwarzania odpowiedzi.
contentEncoding	Jeśli nagłówek żądania Content-Encoding został wcześniej ustawiony dla pliku, wartość Content-Encoding zostanie zwrócona w tym nagłówku.
contentLanguage	Zwraca wartość, która została określona dla nagłówka żądania Content-Language.
contentLength	Rozmiar pliku w bajtach. Ten nagłówek zwraca wartość nagłówka "x-ms-content-length", który jest przechowywany w pliku.
contentMD5	Jeśli nagłówek Content-MD5 został ustawiony dla pliku, zostanie zwrócony nagłówek odpowiedzi Content-MD5, aby klient mógł sprawdzić integralność zawartości komunikatu.
contentType	Typ zawartości określony dla pliku. Domyślnym typem zawartości jest "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 ostatniej próby skopiowania pliku, w którym ten plik był plikiem docelowym.
copyProgress	Zawiera liczbę skopiowanych bajtów i łą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 o długości od 0 do zawartości.
copySource	Adres URL o długości do 2 KB, który określa plik źródłowy używany w ostatniej operacji kopiowania pliku, w której ten plik był plikiem docelowym.
copyStatus	Stan operacji kopiowania zidentyfikowanej przez polecenie "x-ms-copy-id".
copyStatusDescription	Pojawia się tylko wtedy, gdy stan x-ms-copy-status jest niepowodzeniem lub oczekiwaniem. Opisuje przyczynę niepowodzenia operacji kopiowania krytycznego lub niekrytycznego.
date	Wartość daty/godziny UTC wygenerowana przez usługę, która wskazuje godzinę, w 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.
fileCreatedOn	Czas utworzenia pliku.
fileId	FileId pliku.
fileLastWriteOn	Czas ostatniego zapisu dla pliku.
fileParentId	Nadrzędny identyfikator fileId pliku.
filePermissionKey	Klucz zestawu uprawnień dla pliku.
fileType	Zwraca typ Plik. Zarezerwowane do użytku w przyszłości.
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. Format daty jest zgodny z RFC 1123. 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 jest nieskończona, czy stała.
leaseState	Stan dzierżawy pliku.
leaseStatus	Bieżący stan dzierżawy pliku.
metadata	Zestaw par name-value skojarzonych z tym plikiem jako metadanych zdefiniowanych przez użytkownika.
requestId	Ten nagłówek jednoznacznie identyfikuje wykonane żądanie 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

cacheControl

Jeśli nagłówek żądania Cache-Control został wcześniej ustawiony dla pliku, wartość Cache-Control zostanie zwrócona w tym nagłówku.

cacheControl?: string

Wartość właściwości

string

contentDisposition

Zwraca wartość, która została określona dla nagłówka "x-ms-content-disposition" i określa sposób przetwarzania odpowiedzi.

contentDisposition?: string

Wartość właściwości

string

contentEncoding

Jeśli nagłówek żądania Content-Encoding został wcześniej ustawiony dla pliku, wartość Content-Encoding zostanie zwrócona w tym nagłówku.

contentEncoding?: string

Wartość właściwości

string

contentLanguage

Zwraca wartość, która została określona dla nagłówka żądania Content-Language.

contentLanguage?: string

Wartość właściwości

string

contentLength

Rozmiar pliku w bajtach. Ten nagłówek zwraca wartość nagłówka "x-ms-content-length", który jest przechowywany w pliku.

contentLength?: number

Wartość właściwości

number

contentMD5

Jeśli nagłówek Content-MD5 został ustawiony dla pliku, zostanie zwrócony nagłówek odpowiedzi Content-MD5, aby klient mógł sprawdzić integralność zawartości komunikatu.

contentMD5?: Uint8Array

Wartość właściwości

Uint8Array

contentType

Typ zawartości określony dla pliku. Domyślnym typem zawartości jest "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 ostatniej próby skopiowania pliku, w którym ten plik był plikiem docelowym.

copyId?: string

Wartość właściwości

string

copyProgress

Zawiera liczbę skopiowanych bajtów i łą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 o długości od 0 do 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 w ostatniej operacji kopiowania pliku, w której ten plik był plikiem docelowym.

copySource?: string

Wartość właściwości

string

copyStatus

Stan operacji kopiowania zidentyfikowanej 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 jest niepowodzeniem lub oczekiwaniem. 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ę, w 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

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

Nadrzędny identyfikator fileId pliku.

fileParentId?: string

Wartość właściwości

string

filePermissionKey

Klucz zestawu uprawnień dla pliku.

filePermissionKey?: string

Wartość właściwości

string

fileType

Zwraca typ Plik. Zarezerwowane do użytku w przyszłości.

fileType?: 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. Format daty jest zgodny z RFC 1123. 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 jest nieskończona, czy stała.

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 name-value 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 wykonane żądanie 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