ListTaskFilesOptionalParams interface
選擇性參數。
- Extends
屬性
| client |
呼叫端產生的要求身分識別,格式為 GUID,不含大括弧,例如 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0。 |
| filter | OData $filter 子句。 關於建構此濾波器的更多資訊,請參見 https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-task-files。 |
| max |
回應中要傳回的項目數目上限。 最多可提交1000份申請。 |
| ocp |
發出要求的時間。 用戶端連結庫通常會將此設定為目前的系統時鐘時間;如果您要直接呼叫 REST API,請明確設定它。 |
| recursive | 是否列出 Task 目錄的子系。 此參數可以與篩選參數搭配使用,以列出特定類型的檔案。 |
| return |
伺服器是否應該在回應中傳回 client-request-id。 |
| timeout |
伺服器可以花費數秒處理要求的時間上限。 預設值為 30 秒。 若值大於30,則會使用預設值。」 |
繼承的屬性
| abort |
可用來中止要求的訊號。 |
| on |
每次從伺服器收到回應時,要呼叫的函式,同時執行要求的作業。 可以多次呼叫。 |
| request |
建立和傳送此作業之 HTTP 要求時所使用的選項。 |
| tracing |
啟用追蹤時所使用的選項。 |
屬性詳細資料
clientRequestId
呼叫端產生的要求身分識別,格式為 GUID,不含大括弧,例如 9C4D50EE-2D56-4CD3-8152-34347DC9F2B0。
clientRequestId?: string
屬性值
string
filter
OData $filter 子句。 關於建構此濾波器的更多資訊,請參見 https://learn.microsoft.com/rest/api/batchservice/odata-filters-in-batch#list-task-files。
filter?: string
屬性值
string
maxResults
回應中要傳回的項目數目上限。 最多可提交1000份申請。
maxResults?: number
屬性值
number
ocpDate
發出要求的時間。 用戶端連結庫通常會將此設定為目前的系統時鐘時間;如果您要直接呼叫 REST API,請明確設定它。
ocpDate?: Date
屬性值
Date
recursive
是否列出 Task 目錄的子系。 此參數可以與篩選參數搭配使用,以列出特定類型的檔案。
recursive?: boolean
屬性值
boolean
returnClientRequestId
伺服器是否應該在回應中傳回 client-request-id。
returnClientRequestId?: boolean
屬性值
boolean
timeoutInSeconds
伺服器可以花費數秒處理要求的時間上限。 預設值為 30 秒。 若值大於30,則會使用預設值。」
timeoutInSeconds?: number
屬性值
number
繼承的屬性詳細資料
abortSignal
onResponse
每次從伺服器收到回應時,要呼叫的函式,同時執行要求的作業。 可以多次呼叫。
onResponse?: RawResponseCallback
屬性值
繼承自 OperationOptions.onResponse
requestOptions
建立和傳送此作業之 HTTP 要求時所使用的選項。
requestOptions?: OperationRequestOptions
屬性值
繼承自 OperationOptions.requestOptions
tracingOptions
啟用追蹤時所使用的選項。
tracingOptions?: OperationTracingOptions
屬性值
繼承自 OperationOptions.tracingOptions