Skip to content

Commit

Permalink
removing beta annotation
Browse files Browse the repository at this point in the history
  • Loading branch information
jay-most committed May 26, 2022
1 parent b9a7129 commit fa96efc
Show file tree
Hide file tree
Showing 6 changed files with 31 additions and 36 deletions.
15 changes: 4 additions & 11 deletions sdk/cosmosdb/cosmos/review/cosmos.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -672,11 +672,6 @@ export enum DataType {
String = "String"
}

// @beta
export interface DedicatedGatewayRequestOptions {
maxIntegratedCacheStalenessInMs?: number;
}

// @public (undocumented)
export const DEFAULT_PARTITION_KEY_PATH: "/_partitionKey";

Expand Down Expand Up @@ -736,10 +731,8 @@ export type ExistingKeyOperation = {
// @public (undocumented)
export function extractPartitionKey(document: unknown, partitionKeyDefinition: PartitionKeyDefinition): PartitionKey[];

// Warning: (ae-incompatible-release-tags) The symbol "FeedOptions" is marked as @public, but its signature references "DedicatedGatewayRequestOptions" which is marked as @beta
//
// @public
export interface FeedOptions extends SharedOptions, DedicatedGatewayRequestOptions {
export interface FeedOptions extends SharedOptions {
accessCondition?: {
type: string;
condition: string;
Expand All @@ -752,6 +745,7 @@ export interface FeedOptions extends SharedOptions, DedicatedGatewayRequestOptio
enableScanInQuery?: boolean;
forceQueryPlan?: boolean;
maxDegreeOfParallelism?: number;
maxIntegratedCacheStalenessInMs?: number;
maxItemCount?: number;
partitionKey?: any;
populateQueryMetrics?: boolean;
Expand Down Expand Up @@ -1468,10 +1462,8 @@ interface RequestInfo_2 {
}
export { RequestInfo_2 as RequestInfo }

// Warning: (ae-incompatible-release-tags) The symbol "RequestOptions" is marked as @public, but its signature references "DedicatedGatewayRequestOptions" which is marked as @beta
//
// @public
export interface RequestOptions extends SharedOptions, DedicatedGatewayRequestOptions {
export interface RequestOptions extends SharedOptions {
accessCondition?: {
type: string;
condition: string;
Expand All @@ -1481,6 +1473,7 @@ export interface RequestOptions extends SharedOptions, DedicatedGatewayRequestOp
disableRUPerMinuteUsage?: boolean;
enableScriptLogging?: boolean;
indexingDirective?: string;
maxIntegratedCacheStalenessInMs?: number;
offerThroughput?: number;
offerType?: string;
populateQuotaInfo?: boolean;
Expand Down
19 changes: 0 additions & 19 deletions sdk/cosmosdb/cosmos/src/request/DedicatedGatewayRequestOptions.ts

This file was deleted.

15 changes: 13 additions & 2 deletions sdk/cosmosdb/cosmos/src/request/FeedOptions.ts
Original file line number Diff line number Diff line change
@@ -1,12 +1,11 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.
import { DedicatedGatewayRequestOptions } from "..";
import { SharedOptions } from "./SharedOptions";

/**
* The feed options and query methods.
*/
export interface FeedOptions extends SharedOptions, DedicatedGatewayRequestOptions {
export interface FeedOptions extends SharedOptions {
/** Opaque token for continuing the enumeration. Default: undefined
* @deprecated Use continuationToken instead.
*/
Expand Down Expand Up @@ -97,4 +96,16 @@ export interface FeedOptions extends SharedOptions, DedicatedGatewayRequestOptio
* but you still want to restrict it to a single partition. Example: an end user specified query.
*/
partitionKey?: any;
/**
* **(Beta - There may be breaking changes in this property in future releases)**
* Sets the staleness value associated with the request in the Azure CosmosDB service. For requests where the {@link
* com.azure.cosmos.ConsistencyLevel} is {@link com.azure.cosmos.ConsistencyLevel#EVENTUAL}, responses from the
* integrated cache are guaranteed to be no staler than value indicated by this maxIntegratedCacheStaleness. When the
* consistency level is not set, this property is ignored.
*
* <p>Default value is null</p>
*
* <p>Cache Staleness is supported in milliseconds granularity. Anything smaller than milliseconds will be ignored.</p>
*/
maxIntegratedCacheStalenessInMs?: number;
}
16 changes: 14 additions & 2 deletions sdk/cosmosdb/cosmos/src/request/RequestOptions.ts
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
// Copyright (c) Microsoft Corporation.
// Licensed under the MIT license.
import { DedicatedGatewayRequestOptions, SharedOptions } from "..";
import { SharedOptions } from "..";

/**
* Options that can be specified for a requested issued to the Azure Cosmos DB servers.=
*/
export interface RequestOptions extends SharedOptions, DedicatedGatewayRequestOptions {
export interface RequestOptions extends SharedOptions {
/** Conditions Associated with the request. */
accessCondition?: {
/** Conditional HTTP method header type (IfMatch or IfNoneMatch). */
Expand Down Expand Up @@ -44,4 +44,16 @@ export interface RequestOptions extends SharedOptions, DedicatedGatewayRequestOp
urlConnection?: string;
/** Disable automatic id generation (will cause creates to fail if id isn't on the definition) */
disableAutomaticIdGeneration?: boolean;
/**
* **(Beta - There may be breaking changes in this property in future releases)**
* Sets the staleness value associated with the request in the Azure CosmosDB service. For requests where the {@link
* com.azure.cosmos.ConsistencyLevel} is {@link com.azure.cosmos.ConsistencyLevel#EVENTUAL}, responses from the
* integrated cache are guaranteed to be no staler than value indicated by this maxIntegratedCacheStaleness. When the
* consistency level is not set, this property is ignored.
*
* <p>Default value is null</p>
*
* <p>Cache Staleness is supported in milliseconds granularity. Anything smaller than milliseconds will be ignored.</p>
*/
maxIntegratedCacheStalenessInMs?: number;
}
1 change: 0 additions & 1 deletion sdk/cosmosdb/cosmos/src/request/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -18,4 +18,3 @@ export { SharedOptions } from "./SharedOptions";
export { StatusCode, SubStatusCode } from "./StatusCodes";
export { FeedResponse } from "./FeedResponse";
export { RequestContext } from "./RequestContext";
export { DedicatedGatewayRequestOptions } from "./DedicatedGatewayRequestOptions";
1 change: 0 additions & 1 deletion sdk/cosmosdb/cosmos/tsconfig.strict.json
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,6 @@
"src/client/Database/index.ts",
"src/documents/index.ts",
"src/request/index.ts",
"src/request/DedicatedGatewayRequestOptions.ts",
"src/index.ts",
"src/retry/index.ts",
"src/queryExecutionContext/Aggregators/index.ts",
Expand Down

0 comments on commit fa96efc

Please sign in to comment.