@dynatrace-sdk/client-classic-environment-v2 5.2.3 → 6.1.0

package/types/packages/client/classic-environment-v2/src/lib/apis/events-api.d.ts

@@ -1,316 +0,0 @@
-import { AbortSignal, HttpClient } from '@dynatrace-sdk/http-client';
-import { Event } from '../models/event';
-import { EventIngest } from '../models/event-ingest';
-import { EventIngestResults } from '../models/event-ingest-results';
-import { EventList } from '../models/event-list';
-import { EventPropertiesList } from '../models/event-properties-list';
-import { EventPropertyDetails } from '../models/event-property-details';
-import { EventType } from '../models/event-type';
-import { EventTypeList } from '../models/event-type-list';
-import { ApiClientOptions } from './api-client-options';
-/**
- * Manage events
- */
-export declare class EventsClient {
-    private httpClient;
-    private shouldTransformDates;
-    /**
-     * @param {HttpClient} httpClientImplementation - You can provide custom http client as a parameter to constructor of a EventsClient. Custom http client should implement {HttpClient} interface.
-     * @param {ApiClientOptions} [options] - Optional configuration for SDK Client.
-     * @example
-     * const eventsClientNodeJs = new EventsClient(yourCustomImplementation);
-     */
-    constructor(httpClientImplementation: HttpClient, options?: ApiClientOptions);
-    /**
-     * Lists all event properties
-     *
-     * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
-     *
-     * @returns {Promise<EventPropertiesList>} Success
-     *
-     * @example <caption>Code example</caption>
-     * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data = await eventsClient.getEventProperties();
-     *
-     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
-     * @throws {InvalidResponseError}
-     * @throws {ApiClientError}
-     * @throws {ClientRequestError}
-     */
-    getEventProperties(config?: {
-        /**
-         * The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
-         *
-         * The first page is always returned if you don't specify the **nextPageKey** query parameter.
-         *
-         * When the **nextPageKey** is set to obtain subsequent pages, you must omit all other query parameters.
-         */ nextPageKey?: string;
-        /**
-         * The amount of event properties in a single response payload.
-         *
-         * The maximal allowed page size is 500.
-         *
-         * If not set, 100 is used.
-         */ pageSize?: number;
-        abortSignal?: AbortSignal;
-    }): Promise<EventPropertiesList>;
-    /**
-     * Gets the details of an event property
-     *
-     * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
-     *
-     * @returns {Promise<EventPropertyDetails>} Success
-     *
-     * @example <caption>Code example</caption>
-     * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data = await eventsClient.getEventProperty({
-     *   propertyKey: "...",
-     * });
-     *
-     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
-     * @throws {InvalidResponseError}
-     * @throws {ApiClientError}
-     * @throws {ClientRequestError}
-     */
-    getEventProperty(config: {
-        /** The event property key you're inquiring. */ propertyKey: string;
-        abortSignal?: AbortSignal;
-    }): Promise<EventPropertyDetails>;
-    /**
-     * Lists all event types
-     *
-     * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
-     *
-     * @returns {Promise<EventTypeList>} Success
-     *
-     * @example <caption>Code example</caption>
-     * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data = await eventsClient.getEventTypes();
-     *
-     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
-     * @throws {InvalidResponseError}
-     * @throws {ApiClientError}
-     * @throws {ClientRequestError}
-     */
-    getEventTypes(config?: {
-        /**
-         * The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
-         *
-         * The first page is always returned if you don't specify the **nextPageKey** query parameter.
-         *
-         * When the **nextPageKey** is set to obtain subsequent pages, you must omit all other query parameters.
-         */ nextPageKey?: string;
-        /**
-         * The amount of event types in a single response payload.
-         *
-         * The maximal allowed page size is 500.
-         *
-         * If not set, 100 is used.
-         */ pageSize?: number;
-        abortSignal?: AbortSignal;
-    }): Promise<EventTypeList>;
-    /**
-     * Gets the properties of an event type
-     *
-     * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
-     *
-     * @returns {Promise<EventType>} Success
-     *
-     * @example <caption>Code example</caption>
-     * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data = await eventsClient.getEventType({
-     *   eventType: "...",
-     * });
-     *
-     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
-     * @throws {InvalidResponseError}
-     * @throws {ApiClientError}
-     * @throws {ClientRequestError}
-     */
-    getEventType(config: {
-        /** The event type you're inquiring. */ eventType: string;
-        abortSignal?: AbortSignal;
-    }): Promise<EventType>;
-    /**
-     * Lists events within the specified timeframe
-     *
-     * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
-     *
-     * @returns {Promise<EventList>} Success. The response contains the list of events.
-     *
-     * @example <caption>Code example</caption>
-     * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data = await eventsClient.getEvents();
-     *
-     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
-     * @throws {InvalidResponseError}
-     * @throws {ApiClientError}
-     * @throws {ClientRequestError}
-     */
-    getEvents(config?: {
-        /**
-         * The cursor for the next page of results. You can find it in the **nextPageKey** field of the previous response.
-         *
-         * The first page is always returned if you don't specify the **nextPageKey** query parameter.
-         *
-         * When the **nextPageKey** is set to obtain subsequent pages, you must omit all other query parameters.
-         */ nextPageKey?: string;
-        /**
-         * The amount of events in a single response payload.
-         *
-         * The maximal allowed page size is 1000.
-         *
-         * If not set, 100 is used.
-         */ pageSize?: number;
-        /**
-         * The start of the requested timeframe.
-         *
-         * You can use one of the following formats:
-         * * Timestamp in UTC milliseconds.
-         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
-         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
-         * You can also specify relative timeframe without an alignment: `now-NU`.
-         * Supported time units for the relative timeframe are:
-         *    * `m`: minutes
-         *    * `h`: hours
-         *    * `d`: days
-         *    * `w`: weeks
-         *    * `M`: months
-         *    * `y`: years
-         *
-         * If not set, the relative timeframe of two hours is used (`now-2h`).
-         */ from?: string;
-        /**
-         * The end of the requested timeframe.
-         *
-         * You can use one of the following formats:
-         * * Timestamp in UTC milliseconds.
-         * * Human-readable format of `2021-01-25T05:57:01.123+01:00`. If no time zone is specified, UTC is used. You can use a space character instead of the `T`. Seconds and fractions of a second are optional.
-         * * Relative timeframe, back from now. The format is `now-NU/A`, where `N` is the amount of time, `U` is the unit of time, and `A` is an alignment. The alignment rounds all the smaller values to the nearest zero in the past. For example, `now-1y/w` is one year back, aligned by a week.
-         * You can also specify relative timeframe without an alignment: `now-NU`.
-         * Supported time units for the relative timeframe are:
-         *    * `m`: minutes
-         *    * `h`: hours
-         *    * `d`: days
-         *    * `w`: weeks
-         *    * `M`: months
-         *    * `y`: years
-         *
-         * If not set, the current timestamp is used.
-         */ to?: string;
-        /**
-         * Defines the scope of the query. Only events matching the specified criteria are included in the response.
-         *
-         * You can add one or several of the criteria listed below. For each criterion you can specify multiple comma-separated values, unless stated otherwise. If several values are specified, the **OR** logic applies.
-         * * Event ID: `eventId("id-1", "id-2")`.
-         * * ID of related entity: `entityId("id-1", "id-2")`.
-         * * Event status: `status("OPEN")` or `status("CLOSED")`. You can specify only one status.
-         * * Management zone ID: `managementZoneId("123", "321")`.
-         * * Event type: `eventType("event-type")`. You can specify only one event type. You can fetch the list of possible event types with the [GET event types](https://dt-url.net/qc03u6w) call.
-         * * Correlation ID: `correlationId("id-1", "id-2")`.
-         * * Happened during maintenance (true, false): `underMaintenance(true)`.
-         * * Notifications are suppressed (true, false): `suppressAlert(true)`.
-         * * Problem creation is suppressed (true, false): `suppressProblem(true)`.
-         * * Frequent event (true, false): `frequentEvent(true)`.
-         * * Event property: `property.<key>("value-1", "value-2")`. Only properties with the **filterable** property set to `true` can be used. You can check event properties via the [GET event properties](https://dt-url.net/es03nwo) call.
-         *
-         * To set several criteria, separate them with commas (`,`). Only results matching **all** criteria are included in the response.
-         */ eventSelector?: string;
-        /**
-         * The entity scope of the query. You must set one of these criteria:
-         *
-         * * Entity type: `type("TYPE")`
-         * * Dynatrace entity ID: `entityId("id")`. You can specify several IDs, separated by a comma (`entityId("id-1","id-2")`). All requested entities must be of the same type.
-         *
-         * You can add one or more of the following criteria. Values are case-sensitive and the `EQUALS` operator is used unless otherwise specified.
-         *
-         * * Tag: `tag("value")`. Tags in `[context]key:value`, `key:value`, and `value` formats are detected and parsed automatically. Any colons (`:`) that are part of the key or value must be escaped with a backslash(`\`). Otherwise, it will be interpreted as the separator between the key and the value. All tag values are case-sensitive.
-         * * Management zone ID: `mzId(123)`
-         * * Management zone name: `mzName("value")`
-         * * Entity name:
-         * 	* `entityName.equals`: performs a non-casesensitive `EQUALS` query.
-         * 	* `entityName.startsWith`: changes the operator to `BEGINS WITH`.
-         * 	* `entityName.in`: enables you to provide multiple values. The `EQUALS` operator applies.
-         * 	* `caseSensitive(entityName.equals("value"))`: takes any entity name criterion as an argument and makes the value case-sensitive.
-         * * Health state (HEALTHY,UNHEALTHY): `healthState("HEALTHY")`
-         * * First seen timestamp: `firstSeenTms.<operator>(now-3h)`. Use any timestamp format from the **from** /**to** parameters.
-         * 	The following operators are available:
-         * 	* `lte`: earlier than or at the specified time
-         * 	* `lt`: earlier than the specified time
-         * 	* `gte`: later than or at the specified time
-         * 	* `gt`: later than the specified time
-         * * Entity attribute: `<attribute>("value1","value2")` and `<attribute>.exists()`. To fetch the list of available attributes, execute the [GET entity type](https://dt-url.net/2ka3ivt) request and check the **properties** field of the response.
-         * * Relationships: `fromRelationships.<relationshipName>()` and `toRelationships.<relationshipName>()`. This criterion takes an entity selector as an attribute. To fetch the list of available relationships, execute the [GET entity type](https://dt-url.net/2ka3ivt) request and check the **fromRelationships** and **toRelationships** fields.
-         * * Negation: `not(<criterion>)`. Inverts any criterion except for **type**.
-         *
-         * For more information, see [Entity selector](https://dt-url.net/apientityselector) in Dynatrace Documentation.
-         *
-         * To set several criteria, separate them with a comma (`,`). For example, `type("HOST"),healthState("HEALTHY")`. Only results matching **all** criteria are included in the response.
-         *
-         * The maximum string length is 2,000 characters.
-         *
-         * The number of entities that can be selected is limited to 10000.
-         */ entitySelector?: string;
-        abortSignal?: AbortSignal;
-    }): Promise<EventList>;
-    /**
-     * Ingests a custom event
-     *
-     * **One of the following scopes is required:**
-     * + storage:events:write
-     * + environment-api:events:write
-     *
-     * <br/>**One of the following permissions is required:**
-     * + environment:roles:viewer
-     * + storage:events:write
-     *
-     * <br/><br/>The ingestion of custom events is subject to licensing (see [licensing documentation](https://www.dynatrace.com/support/help/shortlink/dps-events)).
-     *
-     * @returns {Promise<EventIngestResults>} The event ingest request was received by the server. The response body indicates for each event whether its creation was successful.
-     *
-     * @example <caption>Code example</caption>
-     * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data = await eventsClient.createEvent({
-     *   body: { eventType: "AVAILABILITY_EVENT", title: "..." },
-     * });
-     *
-     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
-     * @throws {InvalidResponseError}
-     * @throws {ApiClientError}
-     * @throws {ClientRequestError}
-     */
-    createEvent(config: {
-        body: EventIngest;
-        abortSignal?: AbortSignal;
-    }): Promise<EventIngestResults>;
-    /**
-     * Gets the properties of an event
-     *
-     * **Required scope:** environment-api:events:read<br/>**Required permission:** environment:roles:viewer
-     *
-     * @returns {Promise<Event>} Success. The response contains the configuration of the event.
-     *
-     * @example <caption>Code example</caption>
-     * import { eventsClient } from "@dynatrace-sdk/client-classic-environment-v2";
-     *
-     * const data = await eventsClient.getEvent({
-     *   eventId: "...",
-     * });
-     *
-     * @throws {ErrorEnvelopeError} Client side error. | Server side error.
-     * @throws {InvalidResponseError}
-     * @throws {ApiClientError}
-     * @throws {ClientRequestError}
-     */
-    getEvent(config: {
-        /** The ID of the required event. */ eventId: string;
-        abortSignal?: AbortSignal;
-    }): Promise<Event>;
-}
-export declare const eventsClient: EventsClient;