oci-apmtraces 2.82.1 → 2.82.2

package/index.d.ts

@@ -18,5 +18,6 @@ import * as client from "./lib/client";
 export { models };
 export { requests };
 export { responses };
+export import AttributesClient = client.AttributesClient;
 export import QueryClient = client.QueryClient;
 export import TraceClient = client.TraceClient;

package/index.js

@@ -32,7 +32,7 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.TraceClient = exports.QueryClient = exports.responses = exports.requests = exports.models = void 0;
+exports.TraceClient = exports.QueryClient = exports.AttributesClient = exports.responses = exports.requests = exports.models = void 0;
 const requests = __importStar(require("./lib/request"));
 exports.requests = requests;
 const models = __importStar(require("./lib/model"));
@@ -40,6 +40,7 @@ exports.models = models;
 const responses = __importStar(require("./lib/response"));
 exports.responses = responses;
 const client = __importStar(require("./lib/client"));
+exports.AttributesClient = client.AttributesClient;
 exports.QueryClient = client.QueryClient;
 exports.TraceClient = client.TraceClient;
 //# sourceMappingURL=index.js.map

package/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/apmtraces/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;GAYG;;;;;;;;;;;;;;;;;;;;;;AAEH,wDAA0C;AAMjC,4BAAQ;AALjB,oDAAsC;AAI7B,wBAAM;AAHf,0DAA4C;AAKnC,8BAAS;AAJlB,qDAAuC;AAKzB,QAAA,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;AACjC,QAAA,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../lib/apmtraces/index.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;GAYG;;;;;;;;;;;;;;;;;;;;;;AAEH,wDAA0C;AAMjC,4BAAQ;AALjB,oDAAsC;AAI7B,wBAAM;AAHf,0DAA4C;AAKnC,8BAAS;AAJlB,qDAAuC;AAKzB,QAAA,gBAAgB,GAAG,MAAM,CAAC,gBAAgB,CAAC;AAC3C,QAAA,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC;AACjC,QAAA,WAAW,GAAG,MAAM,CAAC,WAAW,CAAC"}

package/lib/client.d.ts

@@ -16,6 +16,159 @@ import * as requests from "./request";
 import * as model from "./model";
 import * as responses from "./response";
 declare const Breaker: any;
+export declare enum AttributesApiKeys {
+}
+/**
+ * This service client uses {@link common.CircuitBreaker.DefaultConfiguration} for all the operations by default if no circuit breaker configuration is defined by the user.
+ */
+export declare class AttributesClient {
+    protected static serviceEndpointTemplate: string;
+    protected static endpointServiceName: string;
+    protected "_realmSpecificEndpointTemplateEnabled": boolean | undefined;
+    protected "_endpoint": string;
+    protected "_defaultHeaders": any;
+    protected "_clientConfiguration": common.ClientConfiguration;
+    protected _circuitBreaker: typeof Breaker | null;
+    protected _httpOptions: any;
+    protected _bodyDuplexMode: any;
+    targetService: string;
+    protected _regionId: string;
+    protected "_region": common.Region;
+    protected _lastSetRegionOrRegionId: string;
+    protected _httpClient: common.HttpClient;
+    constructor(params: common.AuthParams, clientConfiguration?: common.ClientConfiguration);
+    /**
+     * Get the endpoint that is being used to call (ex, https://www.example.com).
+     */
+    get endpoint(): string;
+    /**
+     * Sets the endpoint to call (ex, https://www.example.com).
+     * @param endpoint The endpoint of the service.
+     */
+    set endpoint(endpoint: string);
+    get logger(): import("oci-common/lib/log").Logger;
+    /**
+     * Determines whether realm specific endpoint should be used or not.
+     * Set realmSpecificEndpointTemplateEnabled to "true" if the user wants to enable use of realm specific endpoint template, otherwise set it to "false"
+     * @param realmSpecificEndpointTemplateEnabled flag to enable the use of realm specific endpoint template
+     */
+    set useRealmSpecificEndpointTemplate(realmSpecificEndpointTemplateEnabled: boolean);
+    /**
+     * Sets the region to call (ex, Region.US_PHOENIX_1).
+     * Note, this will call {@link #endpoint(String) endpoint} after resolving the endpoint.
+     * @param region The region of the service.
+     */
+    set region(region: common.Region);
+    /**
+     * Sets the regionId to call (ex, 'us-phoenix-1').
+     *
+     * Note, this will first try to map the region ID to a known Region and call {@link #region(Region) region}.
+     * If no known Region could be determined, it will create an endpoint assuming its in default Realm OC1
+     * and then call {@link #endpoint(String) endpoint}.
+     * @param regionId The public region ID.
+     */
+    set regionId(regionId: string);
+    /**
+     * Shutdown the circuit breaker used by the client when it is no longer needed
+     */
+    shutdownCircuitBreaker(): void;
+    /**
+     * Activates a set of attributes for the given APM Domain.  The API is not case-sensitive.  Any duplicates present in the bulk activation
+     * request are deduplicated and only unique attributes are activated.  A maximum number of 700 string attributes and 100 numeric attributes
+     * can be activated in an APM Domain subject to the available string and numeric slots.  Once an attribute has been activated, it may take sometime
+     * for it to be appear in searches as ingest might not have picked up the changes or any associated caches might not have refreshed.  The
+     * bulk activation operation is atomic, and the operation succeeds only if all the attributes in the request have been processed successfully and they
+     * get a success status back.  If the processing of any attribute results in a processing or validation error, then none of the attributes in the bulk
+     * request are activated.  Attributes that are activated are unpinned by default if they are pinned.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param BulkActivateAttributeRequest
+     * @return BulkActivateAttributeResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.82.2/apmtraces/BulkActivateAttribute.ts.html |here} to see how to use BulkActivateAttribute API.
+     */
+    bulkActivateAttribute(bulkActivateAttributeRequest: requests.BulkActivateAttributeRequest): Promise<responses.BulkActivateAttributeResponse>;
+    /**
+     * Deactivates a set of attributes for the given APM Domain.  The API is case in-sensitive.  Any duplicates present in the bulk deactivation
+     * request are deduplicated and only unique attributes are deactivated.  A maximum number of 700 string attributes and 100 numeric attributes
+     * can be deactivated in an APM Domain subject to the available string and numeric slots.  Out of box attributes (Trace and Span) cannot be
+     * deactivated, and will result in a processing error.  Once an attribute has been deactivated, it may take sometime for it to disappear in
+     * searches as ingest might not have picked up the changes or any associated caches might not have refreshed.  The bulk deactivation
+     * operation is atomic, and the operation succeeds only if all the attributes in the request have been processed successfully and they get a success
+     * status back.  If the processing of any attribute results in a processing or validation error, then none of the attributes in the bulk request
+     * are deactivated.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param BulkDeActivateAttributeRequest
+     * @return BulkDeActivateAttributeResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.82.2/apmtraces/BulkDeActivateAttribute.ts.html |here} to see how to use BulkDeActivateAttribute API.
+     */
+    bulkDeActivateAttribute(bulkDeActivateAttributeRequest: requests.BulkDeActivateAttributeRequest): Promise<responses.BulkDeActivateAttributeResponse>;
+    /**
+     * Pin a set of attributes in the APM Domain.  Attributes that are marked pinned are not autoactivated by ingest.
+     * Attributes that are deactivated are pinned by default.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param BulkPinAttributeRequest
+     * @return BulkPinAttributeResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.82.2/apmtraces/BulkPinAttribute.ts.html |here} to see how to use BulkPinAttribute API.
+     */
+    bulkPinAttribute(bulkPinAttributeRequest: requests.BulkPinAttributeRequest): Promise<responses.BulkPinAttributeResponse>;
+    /**
+     * Unpin a set of attributes in the APM Domain.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param BulkUnpinAttributeRequest
+     * @return BulkUnpinAttributeResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.82.2/apmtraces/BulkUnpinAttribute.ts.html |here} to see how to use BulkUnpinAttribute API.
+     */
+    bulkUnpinAttribute(bulkUnpinAttributeRequest: requests.BulkUnpinAttributeRequest): Promise<responses.BulkUnpinAttributeResponse>;
+    /**
+     * Update a set of attribute properties in the APM Domain.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param BulkUpdateAttributeRequest
+     * @return BulkUpdateAttributeResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.82.2/apmtraces/BulkUpdateAttribute.ts.html |here} to see how to use BulkUpdateAttribute API.
+     */
+    bulkUpdateAttribute(bulkUpdateAttributeRequest: requests.BulkUpdateAttributeRequest): Promise<responses.BulkUpdateAttributeResponse>;
+    /**
+     * Add or edit notes to a set of attributes in the APM Domain.  Notes can be added to either an active or an inactive attribute.  The
+     * notes will be preserved even if the attribute changes state (when an active attribute is deactivated or when an inactive attribute
+     * is activated).
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param BulkUpdateAttributeNotesRequest
+     * @return BulkUpdateAttributeNotesResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.82.2/apmtraces/BulkUpdateAttributeNotes.ts.html |here} to see how to use BulkUpdateAttributeNotes API.
+     */
+    bulkUpdateAttributeNotes(bulkUpdateAttributeNotesRequest: requests.BulkUpdateAttributeNotesRequest): Promise<responses.BulkUpdateAttributeNotesResponse>;
+    /**
+     * Get autoactivation status for a private data key or public data key in the APM Domain.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param GetStatusAutoActivateRequest
+     * @return GetStatusAutoActivateResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.82.2/apmtraces/GetStatusAutoActivate.ts.html |here} to see how to use GetStatusAutoActivate API.
+     */
+    getStatusAutoActivate(getStatusAutoActivateRequest: requests.GetStatusAutoActivateRequest): Promise<responses.GetStatusAutoActivateResponse>;
+    /**
+     * Turn on or off autoactivate for private data key or public data key traffic a given APM Domain.
+     *
+     * This operation does not retry by default if the user has not defined a retry configuration.
+     * @param PutToggleAutoActivateRequest
+     * @return PutToggleAutoActivateResponse
+     * @throws OciError when an error occurs
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.82.2/apmtraces/PutToggleAutoActivate.ts.html |here} to see how to use PutToggleAutoActivate API.
+     */
+    putToggleAutoActivate(putToggleAutoActivateRequest: requests.PutToggleAutoActivateRequest): Promise<responses.PutToggleAutoActivateResponse>;
+}
 export declare enum QueryApiKeys {
 }
 /**
@@ -80,7 +233,7 @@ export declare class QueryClient {
      * @param ListQuickPicksRequest
      * @return ListQuickPicksResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.82.1/apmtraces/ListQuickPicks.ts.html |here} to see how to use ListQuickPicks API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.82.2/apmtraces/ListQuickPicks.ts.html |here} to see how to use ListQuickPicks API.
      */
     listQuickPicks(listQuickPicksRequest: requests.ListQuickPicksRequest): Promise<responses.ListQuickPicksResponse>;
     /**
@@ -125,7 +278,7 @@ export declare class QueryClient {
      * @param QueryRequest
      * @return QueryResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.82.1/apmtraces/Query.ts.html |here} to see how to use Query API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.82.2/apmtraces/Query.ts.html |here} to see how to use Query API.
      */
     query(queryRequest: requests.QueryRequest): Promise<responses.QueryResponse>;
 }
@@ -192,7 +345,7 @@ export declare class TraceClient {
      * @param GetAggregatedSnapshotRequest
      * @return GetAggregatedSnapshotResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.82.1/apmtraces/GetAggregatedSnapshot.ts.html |here} to see how to use GetAggregatedSnapshot API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.82.2/apmtraces/GetAggregatedSnapshot.ts.html |here} to see how to use GetAggregatedSnapshot API.
      */
     getAggregatedSnapshot(getAggregatedSnapshotRequest: requests.GetAggregatedSnapshotRequest): Promise<responses.GetAggregatedSnapshotResponse>;
     /**
@@ -202,7 +355,7 @@ export declare class TraceClient {
      * @param GetSpanRequest
      * @return GetSpanResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.82.1/apmtraces/GetSpan.ts.html |here} to see how to use GetSpan API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.82.2/apmtraces/GetSpan.ts.html |here} to see how to use GetSpan API.
      */
     getSpan(getSpanRequest: requests.GetSpanRequest): Promise<responses.GetSpanResponse>;
     /**
@@ -212,7 +365,7 @@ export declare class TraceClient {
      * @param GetTraceRequest
      * @return GetTraceResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.82.1/apmtraces/GetTrace.ts.html |here} to see how to use GetTrace API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.82.2/apmtraces/GetTrace.ts.html |here} to see how to use GetTrace API.
      */
     getTrace(getTraceRequest: requests.GetTraceRequest): Promise<responses.GetTraceResponse>;
     /**
@@ -222,7 +375,7 @@ export declare class TraceClient {
      * @param GetTraceSnapshotRequest
      * @return GetTraceSnapshotResponse
      * @throws OciError when an error occurs
-     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.82.1/apmtraces/GetTraceSnapshot.ts.html |here} to see how to use GetTraceSnapshot API.
+     * @example Click {@link https://docs.cloud.oracle.com/en-us/iaas/tools/typescript-sdk-examples/2.82.2/apmtraces/GetTraceSnapshot.ts.html |here} to see how to use GetTraceSnapshot API.
      */
     getTraceSnapshot(getTraceSnapshotRequest: requests.GetTraceSnapshotRequest): Promise<responses.GetTraceSnapshotResponse>;
 }