/
RequestOptions.ts
47 lines (46 loc) · 2.06 KB
/
RequestOptions.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.
import { SharedOptions } from "./SharedOptions";
/**
* Options that can be specified for a requested issued to the Azure Cosmos DB servers.=
*/
export interface RequestOptions extends SharedOptions {
/** Conditions Associated with the request. */
accessCondition?: {
/** Conditional HTTP method header type (IfMatch or IfNoneMatch). */
type: string;
/** Conditional HTTP method header value (the _etag field from the last version you read). */
condition: string;
};
/** Consistency level required by the client. */
consistencyLevel?: string;
/**
* DisableRUPerMinuteUsage is used to enable/disable Request Units(RUs)/minute capacity
* to serve the request if regular provisioned RUs/second is exhausted.
*/
disableRUPerMinuteUsage?: boolean;
/** Enables or disables logging in JavaScript stored procedures. */
enableScriptLogging?: boolean;
/** Specifies indexing directives (index, do not index .. etc). */
indexingDirective?: string;
/** The offer throughput provisioned for a container in measurement of Requests-per-Unit. */
offerThroughput?: number;
/**
* Offer type when creating document containers.
*
* This option is only valid when creating a document container.
*/
offerType?: string;
/** Enables/disables getting document container quota related stats for document container read requests. */
populateQuotaInfo?: boolean;
/** Indicates what is the post trigger to be invoked after the operation. */
postTriggerInclude?: string | string[];
/** Indicates what is the pre trigger to be invoked before the operation. */
preTriggerInclude?: string | string[];
/** Expiry time (in seconds) for resource token associated with permission (applicable only for requests on permissions). */
resourceTokenExpirySeconds?: number;
/** (Advanced use case) The url to connect to. */
urlConnection?: string;
/** Disable automatic id generation (will cause creates to fail if id isn't on the definition) */
disableAutomaticIdGeneration?: boolean;
}