org.openmetadata.client.api.EventsApi Maven / Gradle / Ivy
package org.openmetadata.client.api;
import org.openmetadata.client.ApiClient;
import org.openmetadata.client.EncodingUtils;
import org.openmetadata.client.model.ApiResponse;
import org.openmetadata.client.model.ChangeEvent;
import org.openmetadata.client.model.ConfigureApplication200Response;
import org.openmetadata.client.model.CreateEventSubscription;
import org.openmetadata.client.model.EntityHistory;
import org.openmetadata.client.model.EventList;
import org.openmetadata.client.model.EventSubscription;
import org.openmetadata.client.model.EventSubscriptionDestinationTestRequest;
import org.openmetadata.client.model.EventSubscriptionDiagnosticInfo;
import org.openmetadata.client.model.EventSubscriptionList;
import org.openmetadata.client.model.EventsRecord;
import org.openmetadata.client.model.ResultListFilterResourceDescriptor;
import org.openmetadata.client.model.SubscriptionDestination;
import org.openmetadata.client.model.SubscriptionStatus;
import java.util.UUID;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;
import feign.*;
@javax.annotation.Generated(value = "org.openapitools.codegen.languages.JavaClientCodegen", date = "2024-11-20T14:35:21.920766473Z[Etc/UTC]")
public interface EventsApi extends ApiClient.Api {
/**
* Check If the Publisher Processed All Events
* Return a boolean 'true' or 'false' to indicate if the publisher processed all events
* @param id Id of the Event Subscription (required)
* @return EntityHistory
*/
@RequestLine("GET /v1/events/subscriptions/{id}/processedEvents")
@Headers({
"Accept: application/json",
})
EntityHistory checkIfThePublisherProcessedALlEvents(@Param("id") UUID id);
/**
* Check If the Publisher Processed All Events
* Similar to checkIfThePublisherProcessedALlEvents but it also returns the http response headers .
* Return a boolean 'true' or 'false' to indicate if the publisher processed all events
* @param id Id of the Event Subscription (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/events/subscriptions/{id}/processedEvents")
@Headers({
"Accept: application/json",
})
ApiResponse checkIfThePublisherProcessedALlEventsWithHttpInfo(@Param("id") UUID id);
/**
* Create a new Event Subscription
* Create a new Event Subscription
* @param createEventSubscription (optional)
* @return CreateEventSubscription
*/
@RequestLine("POST /v1/events/subscriptions")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
CreateEventSubscription createEventSubscription(CreateEventSubscription createEventSubscription);
/**
* Create a new Event Subscription
* Similar to createEventSubscription but it also returns the http response headers .
* Create a new Event Subscription
* @param createEventSubscription (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/events/subscriptions")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createEventSubscriptionWithHttpInfo(CreateEventSubscription createEventSubscription);
/**
* Updated an existing or create a new Event Subscription
* Updated an existing or create a new Event Subscription
* @param createEventSubscription (optional)
* @return CreateEventSubscription
*/
@RequestLine("PUT /v1/events/subscriptions")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
CreateEventSubscription createOrUpdateEventSubscription(CreateEventSubscription createEventSubscription);
/**
* Updated an existing or create a new Event Subscription
* Similar to createOrUpdateEventSubscription but it also returns the http response headers .
* Updated an existing or create a new Event Subscription
* @param createEventSubscription (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("PUT /v1/events/subscriptions")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse createOrUpdateEventSubscriptionWithHttpInfo(CreateEventSubscription createEventSubscription);
/**
* Delete an Event Subscription by Id
* Delete an Event Subscription
* @param id Id of the Event Subscription (required)
* @return EventSubscription
*/
@RequestLine("DELETE /v1/events/subscriptions/{id}")
@Headers({
"Accept: application/json",
})
EventSubscription deleteEventSubscription(@Param("id") UUID id);
/**
* Delete an Event Subscription by Id
* Similar to deleteEventSubscription but it also returns the http response headers .
* Delete an Event Subscription
* @param id Id of the Event Subscription (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("DELETE /v1/events/subscriptions/{id}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteEventSubscriptionWithHttpInfo(@Param("id") UUID id);
/**
* Delete an Event Subscription by name
* Delete an Event Subscription by given `name`.
* @param name Name of the Event Subscription (required)
*/
@RequestLine("DELETE /v1/events/subscriptions/name/{name}")
@Headers({
"Accept: application/json",
})
void deleteEventSubscriptionByName(@Param("name") String name);
/**
* Delete an Event Subscription by name
* Similar to deleteEventSubscriptionByName but it also returns the http response headers .
* Delete an Event Subscription by given `name`.
* @param name Name of the Event Subscription (required)
*/
@RequestLine("DELETE /v1/events/subscriptions/name/{name}")
@Headers({
"Accept: application/json",
})
ApiResponse deleteEventSubscriptionByNameWithHttpInfo(@Param("name") String name);
/**
* Get the destinations for a specific Event Subscription
* Retrieve the status of all destinations associated with the given Event Subscription ID
* @param eventSubscriptionId ID of the Event Subscription (required)
* @return SubscriptionDestination
*/
@RequestLine("GET /v1/events/subscriptions/id/{eventSubscriptionId}/destinations")
@Headers({
"Accept: application/json",
})
SubscriptionDestination getAllDestinationForEventSubscription(@Param("eventSubscriptionId") UUID eventSubscriptionId);
/**
* Get the destinations for a specific Event Subscription
* Similar to getAllDestinationForEventSubscription but it also returns the http response headers .
* Retrieve the status of all destinations associated with the given Event Subscription ID
* @param eventSubscriptionId ID of the Event Subscription (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/events/subscriptions/id/{eventSubscriptionId}/destinations")
@Headers({
"Accept: application/json",
})
ApiResponse getAllDestinationForEventSubscriptionWithHttpInfo(@Param("eventSubscriptionId") UUID eventSubscriptionId);
/**
* Get the destinations for a specific Event Subscription by its name
* Retrieve the status of all destinations associated with the given Event Subscription's fully qualified name (FQN)
* @param eventSubscriptionName Name of the Event Subscription (required)
* @return SubscriptionDestination
*/
@RequestLine("GET /v1/events/subscriptions/name/{eventSubscriptionName}/destinations")
@Headers({
"Accept: application/json",
})
SubscriptionDestination getAllDestinationForEventSubscriptionByName(@Param("eventSubscriptionName") String eventSubscriptionName);
/**
* Get the destinations for a specific Event Subscription by its name
* Similar to getAllDestinationForEventSubscriptionByName but it also returns the http response headers .
* Retrieve the status of all destinations associated with the given Event Subscription's fully qualified name (FQN)
* @param eventSubscriptionName Name of the Event Subscription (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/events/subscriptions/name/{eventSubscriptionName}/destinations")
@Headers({
"Accept: application/json",
})
ApiResponse getAllDestinationForEventSubscriptionByNameWithHttpInfo(@Param("eventSubscriptionName") String eventSubscriptionName);
/**
* Get all failed events
* Retrieve all failed events, optionally filtered by source, and apply a limit.
* @param limit Maximum number of failed events to retrieve (optional, default to 15)
* @param paginationOffset Offset for pagination (starting point for records) (optional, default to 0)
* @param source Source of the failed events (optional)
* @return ChangeEvent
*/
@RequestLine("GET /v1/events/subscriptions/listAllFailedEvents?limit={limit}&paginationOffset={paginationOffset}&source={source}")
@Headers({
"Accept: application/json",
})
ChangeEvent getAllFailedEvents(@Param("limit") Long limit, @Param("paginationOffset") Long paginationOffset, @Param("source") String source);
/**
* Get all failed events
* Similar to getAllFailedEvents but it also returns the http response headers .
* Retrieve all failed events, optionally filtered by source, and apply a limit.
* @param limit Maximum number of failed events to retrieve (optional, default to 15)
* @param paginationOffset Offset for pagination (starting point for records) (optional, default to 0)
* @param source Source of the failed events (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/events/subscriptions/listAllFailedEvents?limit={limit}&paginationOffset={paginationOffset}&source={source}")
@Headers({
"Accept: application/json",
})
ApiResponse getAllFailedEventsWithHttpInfo(@Param("limit") Long limit, @Param("paginationOffset") Long paginationOffset, @Param("source") String source);
/**
* Get all failed events
* Retrieve all failed events, optionally filtered by source, and apply a limit.
* Note, this is equivalent to the other getAllFailedEvents method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link GetAllFailedEventsQueryParams} class that allows for
* building up this map in a fluent style.
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - limit - Maximum number of failed events to retrieve (optional, default to 15)
* - paginationOffset - Offset for pagination (starting point for records) (optional, default to 0)
* - source - Source of the failed events (optional)
*
* @return ChangeEvent
*/
@RequestLine("GET /v1/events/subscriptions/listAllFailedEvents?limit={limit}&paginationOffset={paginationOffset}&source={source}")
@Headers({
"Accept: application/json",
})
ChangeEvent getAllFailedEvents(@QueryMap(encoded=true) GetAllFailedEventsQueryParams queryParams);
/**
* Get all failed events
* Retrieve all failed events, optionally filtered by source, and apply a limit.
* Note, this is equivalent to the other getAllFailedEvents that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - limit - Maximum number of failed events to retrieve (optional, default to 15)
* - paginationOffset - Offset for pagination (starting point for records) (optional, default to 0)
* - source - Source of the failed events (optional)
*
* @return ChangeEvent
*/
@RequestLine("GET /v1/events/subscriptions/listAllFailedEvents?limit={limit}&paginationOffset={paginationOffset}&source={source}")
@Headers({
"Accept: application/json",
})
ApiResponse getAllFailedEventsWithHttpInfo(@QueryMap(encoded=true) GetAllFailedEventsQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getAllFailedEvents method in a fluent style.
*/
public static class GetAllFailedEventsQueryParams extends HashMap {
public GetAllFailedEventsQueryParams limit(final Long value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public GetAllFailedEventsQueryParams paginationOffset(final Long value) {
put("paginationOffset", EncodingUtils.encode(value));
return this;
}
public GetAllFailedEventsQueryParams source(final String value) {
put("source", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a event Subscription by ID
* Get a event Subscription by given Id
* @param id Id of the Event Subscription (required)
* @param fields Fields requested in the returned resource (optional)
* @return EventSubscription
*/
@RequestLine("GET /v1/events/subscriptions/{id}?fields={fields}")
@Headers({
"Accept: application/json",
})
EventSubscription getEventSubscriptionByID(@Param("id") UUID id, @Param("fields") String fields);
/**
* Get a event Subscription by ID
* Similar to getEventSubscriptionByID but it also returns the http response headers .
* Get a event Subscription by given Id
* @param id Id of the Event Subscription (required)
* @param fields Fields requested in the returned resource (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/events/subscriptions/{id}?fields={fields}")
@Headers({
"Accept: application/json",
})
ApiResponse getEventSubscriptionByIDWithHttpInfo(@Param("id") UUID id, @Param("fields") String fields);
/**
* Get a event Subscription by ID
* Get a event Subscription by given Id
* Note, this is equivalent to the other getEventSubscriptionByID method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link GetEventSubscriptionByIDQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the Event Subscription (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
*
* @return EventSubscription
*/
@RequestLine("GET /v1/events/subscriptions/{id}?fields={fields}")
@Headers({
"Accept: application/json",
})
EventSubscription getEventSubscriptionByID(@Param("id") UUID id, @QueryMap(encoded=true) GetEventSubscriptionByIDQueryParams queryParams);
/**
* Get a event Subscription by ID
* Get a event Subscription by given Id
* Note, this is equivalent to the other getEventSubscriptionByID that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the Event Subscription (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
*
* @return EventSubscription
*/
@RequestLine("GET /v1/events/subscriptions/{id}?fields={fields}")
@Headers({
"Accept: application/json",
})
ApiResponse getEventSubscriptionByIDWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) GetEventSubscriptionByIDQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getEventSubscriptionByID method in a fluent style.
*/
public static class GetEventSubscriptionByIDQueryParams extends HashMap {
public GetEventSubscriptionByIDQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
}
/**
* Get an Event Subscription by name
* Get an Event Subscription by name.
* @param eventSubscriptionName Name of the Event Subscription (required)
* @param fields Fields requested in the returned resource (optional)
* @return EventSubscription
*/
@RequestLine("GET /v1/events/subscriptions/name/{eventSubscriptionName}?fields={fields}")
@Headers({
"Accept: application/json",
})
EventSubscription getEventSubscriptionByName(@Param("eventSubscriptionName") String eventSubscriptionName, @Param("fields") String fields);
/**
* Get an Event Subscription by name
* Similar to getEventSubscriptionByName but it also returns the http response headers .
* Get an Event Subscription by name.
* @param eventSubscriptionName Name of the Event Subscription (required)
* @param fields Fields requested in the returned resource (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/events/subscriptions/name/{eventSubscriptionName}?fields={fields}")
@Headers({
"Accept: application/json",
})
ApiResponse getEventSubscriptionByNameWithHttpInfo(@Param("eventSubscriptionName") String eventSubscriptionName, @Param("fields") String fields);
/**
* Get an Event Subscription by name
* Get an Event Subscription by name.
* Note, this is equivalent to the other getEventSubscriptionByName method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link GetEventSubscriptionByNameQueryParams} class that allows for
* building up this map in a fluent style.
* @param eventSubscriptionName Name of the Event Subscription (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
*
* @return EventSubscription
*/
@RequestLine("GET /v1/events/subscriptions/name/{eventSubscriptionName}?fields={fields}")
@Headers({
"Accept: application/json",
})
EventSubscription getEventSubscriptionByName(@Param("eventSubscriptionName") String eventSubscriptionName, @QueryMap(encoded=true) GetEventSubscriptionByNameQueryParams queryParams);
/**
* Get an Event Subscription by name
* Get an Event Subscription by name.
* Note, this is equivalent to the other getEventSubscriptionByName that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param eventSubscriptionName Name of the Event Subscription (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
*
* @return EventSubscription
*/
@RequestLine("GET /v1/events/subscriptions/name/{eventSubscriptionName}?fields={fields}")
@Headers({
"Accept: application/json",
})
ApiResponse getEventSubscriptionByNameWithHttpInfo(@Param("eventSubscriptionName") String eventSubscriptionName, @QueryMap(encoded=true) GetEventSubscriptionByNameQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getEventSubscriptionByName method in a fluent style.
*/
public static class GetEventSubscriptionByNameQueryParams extends HashMap {
public GetEventSubscriptionByNameQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
}
/**
* Get event subscription diagnostic info
* Retrieve diagnostic information for a given event subscription ID, including current and latest offsets, unprocessed events count, and more.
* @param subscriptionId UUID of the Event Subscription (required)
* @param limit Maximum number of unprocessed events returned (optional, default to 15)
* @param paginationOffset Offset for pagination (starting point for records) (optional, default to 0)
* @param listCountOnly Return only count if true (optional, default to false)
* @return EventSubscriptionDiagnosticInfo
*/
@RequestLine("GET /v1/events/subscriptions/id/{subscriptionId}/diagnosticInfo?limit={limit}&paginationOffset={paginationOffset}&listCountOnly={listCountOnly}")
@Headers({
"Accept: application/json",
})
EventSubscriptionDiagnosticInfo getEventSubscriptionDiagnosticInfoById(@Param("subscriptionId") UUID subscriptionId, @Param("limit") Integer limit, @Param("paginationOffset") Long paginationOffset, @Param("listCountOnly") Boolean listCountOnly);
/**
* Get event subscription diagnostic info
* Similar to getEventSubscriptionDiagnosticInfoById but it also returns the http response headers .
* Retrieve diagnostic information for a given event subscription ID, including current and latest offsets, unprocessed events count, and more.
* @param subscriptionId UUID of the Event Subscription (required)
* @param limit Maximum number of unprocessed events returned (optional, default to 15)
* @param paginationOffset Offset for pagination (starting point for records) (optional, default to 0)
* @param listCountOnly Return only count if true (optional, default to false)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/events/subscriptions/id/{subscriptionId}/diagnosticInfo?limit={limit}&paginationOffset={paginationOffset}&listCountOnly={listCountOnly}")
@Headers({
"Accept: application/json",
})
ApiResponse getEventSubscriptionDiagnosticInfoByIdWithHttpInfo(@Param("subscriptionId") UUID subscriptionId, @Param("limit") Integer limit, @Param("paginationOffset") Long paginationOffset, @Param("listCountOnly") Boolean listCountOnly);
/**
* Get event subscription diagnostic info
* Retrieve diagnostic information for a given event subscription ID, including current and latest offsets, unprocessed events count, and more.
* Note, this is equivalent to the other getEventSubscriptionDiagnosticInfoById method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link GetEventSubscriptionDiagnosticInfoByIdQueryParams} class that allows for
* building up this map in a fluent style.
* @param subscriptionId UUID of the Event Subscription (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - limit - Maximum number of unprocessed events returned (optional, default to 15)
* - paginationOffset - Offset for pagination (starting point for records) (optional, default to 0)
* - listCountOnly - Return only count if true (optional, default to false)
*
* @return EventSubscriptionDiagnosticInfo
*/
@RequestLine("GET /v1/events/subscriptions/id/{subscriptionId}/diagnosticInfo?limit={limit}&paginationOffset={paginationOffset}&listCountOnly={listCountOnly}")
@Headers({
"Accept: application/json",
})
EventSubscriptionDiagnosticInfo getEventSubscriptionDiagnosticInfoById(@Param("subscriptionId") UUID subscriptionId, @QueryMap(encoded=true) GetEventSubscriptionDiagnosticInfoByIdQueryParams queryParams);
/**
* Get event subscription diagnostic info
* Retrieve diagnostic information for a given event subscription ID, including current and latest offsets, unprocessed events count, and more.
* Note, this is equivalent to the other getEventSubscriptionDiagnosticInfoById that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param subscriptionId UUID of the Event Subscription (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - limit - Maximum number of unprocessed events returned (optional, default to 15)
* - paginationOffset - Offset for pagination (starting point for records) (optional, default to 0)
* - listCountOnly - Return only count if true (optional, default to false)
*
* @return EventSubscriptionDiagnosticInfo
*/
@RequestLine("GET /v1/events/subscriptions/id/{subscriptionId}/diagnosticInfo?limit={limit}&paginationOffset={paginationOffset}&listCountOnly={listCountOnly}")
@Headers({
"Accept: application/json",
})
ApiResponse getEventSubscriptionDiagnosticInfoByIdWithHttpInfo(@Param("subscriptionId") UUID subscriptionId, @QueryMap(encoded=true) GetEventSubscriptionDiagnosticInfoByIdQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getEventSubscriptionDiagnosticInfoById method in a fluent style.
*/
public static class GetEventSubscriptionDiagnosticInfoByIdQueryParams extends HashMap {
public GetEventSubscriptionDiagnosticInfoByIdQueryParams limit(final Integer value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public GetEventSubscriptionDiagnosticInfoByIdQueryParams paginationOffset(final Long value) {
put("paginationOffset", EncodingUtils.encode(value));
return this;
}
public GetEventSubscriptionDiagnosticInfoByIdQueryParams listCountOnly(final Boolean value) {
put("listCountOnly", EncodingUtils.encode(value));
return this;
}
}
/**
* Get event subscription diagnostic info by name
* Retrieve diagnostic information for a given event subscription name, including current and latest offsets, unprocessed events count, and more.
* @param subscriptionName Name of the Event Subscription (required)
* @param limit Maximum number of unprocessed events returned (optional, default to 15)
* @param paginationOffset Offset for pagination (starting point for records) (optional, default to 0)
* @param listCountOnly Return only count if true (optional, default to false)
* @return EventSubscriptionDiagnosticInfo
*/
@RequestLine("GET /v1/events/subscriptions/name/{subscriptionName}/diagnosticInfo?limit={limit}&paginationOffset={paginationOffset}&listCountOnly={listCountOnly}")
@Headers({
"Accept: application/json",
})
EventSubscriptionDiagnosticInfo getEventSubscriptionDiagnosticInfoByName(@Param("subscriptionName") String subscriptionName, @Param("limit") Integer limit, @Param("paginationOffset") Long paginationOffset, @Param("listCountOnly") Boolean listCountOnly);
/**
* Get event subscription diagnostic info by name
* Similar to getEventSubscriptionDiagnosticInfoByName but it also returns the http response headers .
* Retrieve diagnostic information for a given event subscription name, including current and latest offsets, unprocessed events count, and more.
* @param subscriptionName Name of the Event Subscription (required)
* @param limit Maximum number of unprocessed events returned (optional, default to 15)
* @param paginationOffset Offset for pagination (starting point for records) (optional, default to 0)
* @param listCountOnly Return only count if true (optional, default to false)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/events/subscriptions/name/{subscriptionName}/diagnosticInfo?limit={limit}&paginationOffset={paginationOffset}&listCountOnly={listCountOnly}")
@Headers({
"Accept: application/json",
})
ApiResponse getEventSubscriptionDiagnosticInfoByNameWithHttpInfo(@Param("subscriptionName") String subscriptionName, @Param("limit") Integer limit, @Param("paginationOffset") Long paginationOffset, @Param("listCountOnly") Boolean listCountOnly);
/**
* Get event subscription diagnostic info by name
* Retrieve diagnostic information for a given event subscription name, including current and latest offsets, unprocessed events count, and more.
* Note, this is equivalent to the other getEventSubscriptionDiagnosticInfoByName method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link GetEventSubscriptionDiagnosticInfoByNameQueryParams} class that allows for
* building up this map in a fluent style.
* @param subscriptionName Name of the Event Subscription (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - limit - Maximum number of unprocessed events returned (optional, default to 15)
* - paginationOffset - Offset for pagination (starting point for records) (optional, default to 0)
* - listCountOnly - Return only count if true (optional, default to false)
*
* @return EventSubscriptionDiagnosticInfo
*/
@RequestLine("GET /v1/events/subscriptions/name/{subscriptionName}/diagnosticInfo?limit={limit}&paginationOffset={paginationOffset}&listCountOnly={listCountOnly}")
@Headers({
"Accept: application/json",
})
EventSubscriptionDiagnosticInfo getEventSubscriptionDiagnosticInfoByName(@Param("subscriptionName") String subscriptionName, @QueryMap(encoded=true) GetEventSubscriptionDiagnosticInfoByNameQueryParams queryParams);
/**
* Get event subscription diagnostic info by name
* Retrieve diagnostic information for a given event subscription name, including current and latest offsets, unprocessed events count, and more.
* Note, this is equivalent to the other getEventSubscriptionDiagnosticInfoByName that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param subscriptionName Name of the Event Subscription (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - limit - Maximum number of unprocessed events returned (optional, default to 15)
* - paginationOffset - Offset for pagination (starting point for records) (optional, default to 0)
* - listCountOnly - Return only count if true (optional, default to false)
*
* @return EventSubscriptionDiagnosticInfo
*/
@RequestLine("GET /v1/events/subscriptions/name/{subscriptionName}/diagnosticInfo?limit={limit}&paginationOffset={paginationOffset}&listCountOnly={listCountOnly}")
@Headers({
"Accept: application/json",
})
ApiResponse getEventSubscriptionDiagnosticInfoByNameWithHttpInfo(@Param("subscriptionName") String subscriptionName, @QueryMap(encoded=true) GetEventSubscriptionDiagnosticInfoByNameQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getEventSubscriptionDiagnosticInfoByName method in a fluent style.
*/
public static class GetEventSubscriptionDiagnosticInfoByNameQueryParams extends HashMap {
public GetEventSubscriptionDiagnosticInfoByNameQueryParams limit(final Integer value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public GetEventSubscriptionDiagnosticInfoByNameQueryParams paginationOffset(final Long value) {
put("paginationOffset", EncodingUtils.encode(value));
return this;
}
public GetEventSubscriptionDiagnosticInfoByNameQueryParams listCountOnly(final Boolean value) {
put("listCountOnly", EncodingUtils.encode(value));
return this;
}
}
/**
* Get event subscription events record
* Retrieve the total count, pending count, failed count, and successful count of events for a given event subscription ID.
* @param subscriptionId UUID of the Event Subscription (required)
* @return EventsRecord
*/
@RequestLine("GET /v1/events/subscriptions/id/{subscriptionId}/eventsRecord")
@Headers({
"Accept: application/json",
})
EventsRecord getEventSubscriptionEventsRecordById(@Param("subscriptionId") UUID subscriptionId);
/**
* Get event subscription events record
* Similar to getEventSubscriptionEventsRecordById but it also returns the http response headers .
* Retrieve the total count, pending count, failed count, and successful count of events for a given event subscription ID.
* @param subscriptionId UUID of the Event Subscription (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/events/subscriptions/id/{subscriptionId}/eventsRecord")
@Headers({
"Accept: application/json",
})
ApiResponse getEventSubscriptionEventsRecordByIdWithHttpInfo(@Param("subscriptionId") UUID subscriptionId);
/**
* Get event subscription events record by name
* Retrieve the total count, pending count, failed count, and successful count of events for a given event subscription name.
* @param subscriptionName Name of the Event Subscription (required)
* @return EventsRecord
*/
@RequestLine("GET /v1/events/subscriptions/name/{subscriptionName}/eventsRecord")
@Headers({
"Accept: application/json",
})
EventsRecord getEventSubscriptionEventsRecordByName(@Param("subscriptionName") String subscriptionName);
/**
* Get event subscription events record by name
* Similar to getEventSubscriptionEventsRecordByName but it also returns the http response headers .
* Retrieve the total count, pending count, failed count, and successful count of events for a given event subscription name.
* @param subscriptionName Name of the Event Subscription (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/events/subscriptions/name/{subscriptionName}/eventsRecord")
@Headers({
"Accept: application/json",
})
ApiResponse getEventSubscriptionEventsRecordByNameWithHttpInfo(@Param("subscriptionName") String subscriptionName);
/**
* Get Event Subscription status
* Get a event Subscription status by given Name
* @param eventSubscriptionName Name of the Event Subscription (required)
* @param destinationId Destination Id (required)
* @return SubscriptionStatus
*/
@RequestLine("GET /v1/events/subscriptions/name/{eventSubscriptionName}/status/{destinationId}")
@Headers({
"Accept: application/json",
})
SubscriptionStatus getEventSubscriptionStatus(@Param("eventSubscriptionName") String eventSubscriptionName, @Param("destinationId") UUID destinationId);
/**
* Get Event Subscription status
* Similar to getEventSubscriptionStatus but it also returns the http response headers .
* Get a event Subscription status by given Name
* @param eventSubscriptionName Name of the Event Subscription (required)
* @param destinationId Destination Id (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/events/subscriptions/name/{eventSubscriptionName}/status/{destinationId}")
@Headers({
"Accept: application/json",
})
ApiResponse getEventSubscriptionStatusWithHttpInfo(@Param("eventSubscriptionName") String eventSubscriptionName, @Param("destinationId") UUID destinationId);
/**
* Get Event Subscription status by Id
* Get a event Subscription status by given Name
* @param eventSubscriptionId Name of the Event Subscription (required)
* @param destinationId Destination Id (required)
* @return SubscriptionStatus
*/
@RequestLine("GET /v1/events/subscriptions/{eventSubscriptionId}/status/{destinationId}")
@Headers({
"Accept: application/json",
})
SubscriptionStatus getEventSubscriptionStatusById(@Param("eventSubscriptionId") UUID eventSubscriptionId, @Param("destinationId") UUID destinationId);
/**
* Get Event Subscription status by Id
* Similar to getEventSubscriptionStatusById but it also returns the http response headers .
* Get a event Subscription status by given Name
* @param eventSubscriptionId Name of the Event Subscription (required)
* @param destinationId Destination Id (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/events/subscriptions/{eventSubscriptionId}/status/{destinationId}")
@Headers({
"Accept: application/json",
})
ApiResponse getEventSubscriptionStatusByIdWithHttpInfo(@Param("eventSubscriptionId") UUID eventSubscriptionId, @Param("destinationId") UUID destinationId);
/**
* Retrieve events based on various filters
* Retrieve failed, successfully sent, or unprocessed change events, identified by alert ID, with an optional limit. If status is not provided, retrieves data from all statuses in ascending timestamp.
* @param id ID of the alert or destination (required)
* @param status Status of events to retrieve (failed, successful) (optional)
* @param limit Maximum number of events to retrieve (optional, default to 15)
* @param paginationOffset Offset for pagination (starting point for records) (optional, default to 0)
*/
@RequestLine("GET /v1/events/subscriptions/id/{id}/listEvents?status={status}&limit={limit}&paginationOffset={paginationOffset}")
@Headers({
"Accept: application/json",
})
void getEvents(@Param("id") UUID id, @Param("status") String status, @Param("limit") Long limit, @Param("paginationOffset") Long paginationOffset);
/**
* Retrieve events based on various filters
* Similar to getEvents but it also returns the http response headers .
* Retrieve failed, successfully sent, or unprocessed change events, identified by alert ID, with an optional limit. If status is not provided, retrieves data from all statuses in ascending timestamp.
* @param id ID of the alert or destination (required)
* @param status Status of events to retrieve (failed, successful) (optional)
* @param limit Maximum number of events to retrieve (optional, default to 15)
* @param paginationOffset Offset for pagination (starting point for records) (optional, default to 0)
*/
@RequestLine("GET /v1/events/subscriptions/id/{id}/listEvents?status={status}&limit={limit}&paginationOffset={paginationOffset}")
@Headers({
"Accept: application/json",
})
ApiResponse getEventsWithHttpInfo(@Param("id") UUID id, @Param("status") String status, @Param("limit") Long limit, @Param("paginationOffset") Long paginationOffset);
/**
* Retrieve events based on various filters
* Retrieve failed, successfully sent, or unprocessed change events, identified by alert ID, with an optional limit. If status is not provided, retrieves data from all statuses in ascending timestamp.
* Note, this is equivalent to the other getEvents method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link GetEventsQueryParams} class that allows for
* building up this map in a fluent style.
* @param id ID of the alert or destination (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - status - Status of events to retrieve (failed, successful) (optional)
* - limit - Maximum number of events to retrieve (optional, default to 15)
* - paginationOffset - Offset for pagination (starting point for records) (optional, default to 0)
*
*/
@RequestLine("GET /v1/events/subscriptions/id/{id}/listEvents?status={status}&limit={limit}&paginationOffset={paginationOffset}")
@Headers({
"Accept: application/json",
})
void getEvents(@Param("id") UUID id, @QueryMap(encoded=true) GetEventsQueryParams queryParams);
/**
* Retrieve events based on various filters
* Retrieve failed, successfully sent, or unprocessed change events, identified by alert ID, with an optional limit. If status is not provided, retrieves data from all statuses in ascending timestamp.
* Note, this is equivalent to the other getEvents that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id ID of the alert or destination (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - status - Status of events to retrieve (failed, successful) (optional)
* - limit - Maximum number of events to retrieve (optional, default to 15)
* - paginationOffset - Offset for pagination (starting point for records) (optional, default to 0)
*
*/
@RequestLine("GET /v1/events/subscriptions/id/{id}/listEvents?status={status}&limit={limit}&paginationOffset={paginationOffset}")
@Headers({
"Accept: application/json",
})
ApiResponse getEventsWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) GetEventsQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getEvents method in a fluent style.
*/
public static class GetEventsQueryParams extends HashMap {
public GetEventsQueryParams status(final String value) {
put("status", EncodingUtils.encode(value));
return this;
}
public GetEventsQueryParams limit(final Long value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public GetEventsQueryParams paginationOffset(final Long value) {
put("paginationOffset", EncodingUtils.encode(value));
return this;
}
}
/**
* Get failed events for a subscription by id
* Retrieve failed events for a given subscription id.
* @param id Id of the Event Subscription (required)
* @param limit Maximum number of failed events to retrieve (optional, default to 15)
* @param paginationOffset Offset for pagination (starting point for records) (optional, default to 0)
* @param source Source of the failed events (optional)
* @return ChangeEvent
*/
@RequestLine("GET /v1/events/subscriptions/id/{id}/failedEvents?limit={limit}&paginationOffset={paginationOffset}&source={source}")
@Headers({
"Accept: application/json",
})
ChangeEvent getFailedEventsBySubscriptionId(@Param("id") UUID id, @Param("limit") Long limit, @Param("paginationOffset") Long paginationOffset, @Param("source") String source);
/**
* Get failed events for a subscription by id
* Similar to getFailedEventsBySubscriptionId but it also returns the http response headers .
* Retrieve failed events for a given subscription id.
* @param id Id of the Event Subscription (required)
* @param limit Maximum number of failed events to retrieve (optional, default to 15)
* @param paginationOffset Offset for pagination (starting point for records) (optional, default to 0)
* @param source Source of the failed events (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/events/subscriptions/id/{id}/failedEvents?limit={limit}&paginationOffset={paginationOffset}&source={source}")
@Headers({
"Accept: application/json",
})
ApiResponse getFailedEventsBySubscriptionIdWithHttpInfo(@Param("id") UUID id, @Param("limit") Long limit, @Param("paginationOffset") Long paginationOffset, @Param("source") String source);
/**
* Get failed events for a subscription by id
* Retrieve failed events for a given subscription id.
* Note, this is equivalent to the other getFailedEventsBySubscriptionId method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link GetFailedEventsBySubscriptionIdQueryParams} class that allows for
* building up this map in a fluent style.
* @param id Id of the Event Subscription (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - limit - Maximum number of failed events to retrieve (optional, default to 15)
* - paginationOffset - Offset for pagination (starting point for records) (optional, default to 0)
* - source - Source of the failed events (optional)
*
* @return ChangeEvent
*/
@RequestLine("GET /v1/events/subscriptions/id/{id}/failedEvents?limit={limit}&paginationOffset={paginationOffset}&source={source}")
@Headers({
"Accept: application/json",
})
ChangeEvent getFailedEventsBySubscriptionId(@Param("id") UUID id, @QueryMap(encoded=true) GetFailedEventsBySubscriptionIdQueryParams queryParams);
/**
* Get failed events for a subscription by id
* Retrieve failed events for a given subscription id.
* Note, this is equivalent to the other getFailedEventsBySubscriptionId that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id Id of the Event Subscription (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - limit - Maximum number of failed events to retrieve (optional, default to 15)
* - paginationOffset - Offset for pagination (starting point for records) (optional, default to 0)
* - source - Source of the failed events (optional)
*
* @return ChangeEvent
*/
@RequestLine("GET /v1/events/subscriptions/id/{id}/failedEvents?limit={limit}&paginationOffset={paginationOffset}&source={source}")
@Headers({
"Accept: application/json",
})
ApiResponse getFailedEventsBySubscriptionIdWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) GetFailedEventsBySubscriptionIdQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getFailedEventsBySubscriptionId method in a fluent style.
*/
public static class GetFailedEventsBySubscriptionIdQueryParams extends HashMap {
public GetFailedEventsBySubscriptionIdQueryParams limit(final Long value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public GetFailedEventsBySubscriptionIdQueryParams paginationOffset(final Long value) {
put("paginationOffset", EncodingUtils.encode(value));
return this;
}
public GetFailedEventsBySubscriptionIdQueryParams source(final String value) {
put("source", EncodingUtils.encode(value));
return this;
}
}
/**
* Get failed events for a subscription by name
* Retrieve failed events for a given subscription name.
* @param eventSubscriptionName Name of the Event Subscription (required)
* @param limit Maximum number of failed events to retrieve (optional, default to 15)
* @param paginationOffset Offset for pagination (starting point for records) (optional, default to 0)
* @param source Source of the failed events (optional)
* @return ChangeEvent
*/
@RequestLine("GET /v1/events/subscriptions/name/{eventSubscriptionName}/failedEvents?limit={limit}&paginationOffset={paginationOffset}&source={source}")
@Headers({
"Accept: application/json",
})
ChangeEvent getFailedEventsBySubscriptionName(@Param("eventSubscriptionName") String eventSubscriptionName, @Param("limit") Long limit, @Param("paginationOffset") Long paginationOffset, @Param("source") String source);
/**
* Get failed events for a subscription by name
* Similar to getFailedEventsBySubscriptionName but it also returns the http response headers .
* Retrieve failed events for a given subscription name.
* @param eventSubscriptionName Name of the Event Subscription (required)
* @param limit Maximum number of failed events to retrieve (optional, default to 15)
* @param paginationOffset Offset for pagination (starting point for records) (optional, default to 0)
* @param source Source of the failed events (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/events/subscriptions/name/{eventSubscriptionName}/failedEvents?limit={limit}&paginationOffset={paginationOffset}&source={source}")
@Headers({
"Accept: application/json",
})
ApiResponse getFailedEventsBySubscriptionNameWithHttpInfo(@Param("eventSubscriptionName") String eventSubscriptionName, @Param("limit") Long limit, @Param("paginationOffset") Long paginationOffset, @Param("source") String source);
/**
* Get failed events for a subscription by name
* Retrieve failed events for a given subscription name.
* Note, this is equivalent to the other getFailedEventsBySubscriptionName method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link GetFailedEventsBySubscriptionNameQueryParams} class that allows for
* building up this map in a fluent style.
* @param eventSubscriptionName Name of the Event Subscription (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - limit - Maximum number of failed events to retrieve (optional, default to 15)
* - paginationOffset - Offset for pagination (starting point for records) (optional, default to 0)
* - source - Source of the failed events (optional)
*
* @return ChangeEvent
*/
@RequestLine("GET /v1/events/subscriptions/name/{eventSubscriptionName}/failedEvents?limit={limit}&paginationOffset={paginationOffset}&source={source}")
@Headers({
"Accept: application/json",
})
ChangeEvent getFailedEventsBySubscriptionName(@Param("eventSubscriptionName") String eventSubscriptionName, @QueryMap(encoded=true) GetFailedEventsBySubscriptionNameQueryParams queryParams);
/**
* Get failed events for a subscription by name
* Retrieve failed events for a given subscription name.
* Note, this is equivalent to the other getFailedEventsBySubscriptionName that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param eventSubscriptionName Name of the Event Subscription (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - limit - Maximum number of failed events to retrieve (optional, default to 15)
* - paginationOffset - Offset for pagination (starting point for records) (optional, default to 0)
* - source - Source of the failed events (optional)
*
* @return ChangeEvent
*/
@RequestLine("GET /v1/events/subscriptions/name/{eventSubscriptionName}/failedEvents?limit={limit}&paginationOffset={paginationOffset}&source={source}")
@Headers({
"Accept: application/json",
})
ApiResponse getFailedEventsBySubscriptionNameWithHttpInfo(@Param("eventSubscriptionName") String eventSubscriptionName, @QueryMap(encoded=true) GetFailedEventsBySubscriptionNameQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getFailedEventsBySubscriptionName method in a fluent style.
*/
public static class GetFailedEventsBySubscriptionNameQueryParams extends HashMap {
public GetFailedEventsBySubscriptionNameQueryParams limit(final Long value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public GetFailedEventsBySubscriptionNameQueryParams paginationOffset(final Long value) {
put("paginationOffset", EncodingUtils.encode(value));
return this;
}
public GetFailedEventsBySubscriptionNameQueryParams source(final String value) {
put("source", EncodingUtils.encode(value));
return this;
}
}
/**
* Get a version of the Event Subscription
* Get a version of the Event Subscription by given `Id`
* @param id Id of the Event Subscription (required)
* @param version Event Subscription version number in the form `major`.`minor` (required)
* @return EventSubscription
*/
@RequestLine("GET /v1/events/subscriptions/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
EventSubscription getSpecificEventSubscriptionVersion(@Param("id") UUID id, @Param("version") String version);
/**
* Get a version of the Event Subscription
* Similar to getSpecificEventSubscriptionVersion but it also returns the http response headers .
* Get a version of the Event Subscription by given `Id`
* @param id Id of the Event Subscription (required)
* @param version Event Subscription version number in the form `major`.`minor` (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/events/subscriptions/{id}/versions/{version}")
@Headers({
"Accept: application/json",
})
ApiResponse getSpecificEventSubscriptionVersionWithHttpInfo(@Param("id") UUID id, @Param("version") String version);
/**
* Get successfully sent change events for an alert
* Retrieve successfully sent change events for a specific alert, identified by its ID, with an optional limit.
* @param id ID of the alert to retrieve change events for (required)
* @param limit Maximum number of change events to retrieve (optional, default to 15)
* @param paginationOffset Offset for pagination (starting point for records) (optional, default to 0)
* @return ChangeEvent
*/
@RequestLine("GET /v1/events/subscriptions/id/{id}/listSuccessfullySentChangeEvents?limit={limit}&paginationOffset={paginationOffset}")
@Headers({
"Accept: application/json",
})
ChangeEvent getSuccessfullySentChangeEventsForAlert(@Param("id") UUID id, @Param("limit") Long limit, @Param("paginationOffset") Long paginationOffset);
/**
* Get successfully sent change events for an alert
* Similar to getSuccessfullySentChangeEventsForAlert but it also returns the http response headers .
* Retrieve successfully sent change events for a specific alert, identified by its ID, with an optional limit.
* @param id ID of the alert to retrieve change events for (required)
* @param limit Maximum number of change events to retrieve (optional, default to 15)
* @param paginationOffset Offset for pagination (starting point for records) (optional, default to 0)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/events/subscriptions/id/{id}/listSuccessfullySentChangeEvents?limit={limit}&paginationOffset={paginationOffset}")
@Headers({
"Accept: application/json",
})
ApiResponse getSuccessfullySentChangeEventsForAlertWithHttpInfo(@Param("id") UUID id, @Param("limit") Long limit, @Param("paginationOffset") Long paginationOffset);
/**
* Get successfully sent change events for an alert
* Retrieve successfully sent change events for a specific alert, identified by its ID, with an optional limit.
* Note, this is equivalent to the other getSuccessfullySentChangeEventsForAlert method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link GetSuccessfullySentChangeEventsForAlertQueryParams} class that allows for
* building up this map in a fluent style.
* @param id ID of the alert to retrieve change events for (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - limit - Maximum number of change events to retrieve (optional, default to 15)
* - paginationOffset - Offset for pagination (starting point for records) (optional, default to 0)
*
* @return ChangeEvent
*/
@RequestLine("GET /v1/events/subscriptions/id/{id}/listSuccessfullySentChangeEvents?limit={limit}&paginationOffset={paginationOffset}")
@Headers({
"Accept: application/json",
})
ChangeEvent getSuccessfullySentChangeEventsForAlert(@Param("id") UUID id, @QueryMap(encoded=true) GetSuccessfullySentChangeEventsForAlertQueryParams queryParams);
/**
* Get successfully sent change events for an alert
* Retrieve successfully sent change events for a specific alert, identified by its ID, with an optional limit.
* Note, this is equivalent to the other getSuccessfullySentChangeEventsForAlert that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param id ID of the alert to retrieve change events for (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - limit - Maximum number of change events to retrieve (optional, default to 15)
* - paginationOffset - Offset for pagination (starting point for records) (optional, default to 0)
*
* @return ChangeEvent
*/
@RequestLine("GET /v1/events/subscriptions/id/{id}/listSuccessfullySentChangeEvents?limit={limit}&paginationOffset={paginationOffset}")
@Headers({
"Accept: application/json",
})
ApiResponse getSuccessfullySentChangeEventsForAlertWithHttpInfo(@Param("id") UUID id, @QueryMap(encoded=true) GetSuccessfullySentChangeEventsForAlertQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getSuccessfullySentChangeEventsForAlert method in a fluent style.
*/
public static class GetSuccessfullySentChangeEventsForAlertQueryParams extends HashMap {
public GetSuccessfullySentChangeEventsForAlertQueryParams limit(final Long value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public GetSuccessfullySentChangeEventsForAlertQueryParams paginationOffset(final Long value) {
put("paginationOffset", EncodingUtils.encode(value));
return this;
}
}
/**
* Get successfully sent change events for an alert by name
* Retrieve successfully sent change events for a specific alert, identified by its name, with an optional limit.
* @param eventSubscriptionName Name of the alert to retrieve change events for (required)
* @param limit Maximum number of change events to retrieve (optional, default to 15)
* @param paginationOffset Offset for pagination (starting point for records) (optional, default to 0)
* @return ChangeEvent
*/
@RequestLine("GET /v1/events/subscriptions/name/{eventSubscriptionName}/listSuccessfullySentChangeEvents?limit={limit}&paginationOffset={paginationOffset}")
@Headers({
"Accept: application/json",
})
ChangeEvent getSuccessfullySentChangeEventsForAlertByName(@Param("eventSubscriptionName") String eventSubscriptionName, @Param("limit") Long limit, @Param("paginationOffset") Long paginationOffset);
/**
* Get successfully sent change events for an alert by name
* Similar to getSuccessfullySentChangeEventsForAlertByName but it also returns the http response headers .
* Retrieve successfully sent change events for a specific alert, identified by its name, with an optional limit.
* @param eventSubscriptionName Name of the alert to retrieve change events for (required)
* @param limit Maximum number of change events to retrieve (optional, default to 15)
* @param paginationOffset Offset for pagination (starting point for records) (optional, default to 0)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/events/subscriptions/name/{eventSubscriptionName}/listSuccessfullySentChangeEvents?limit={limit}&paginationOffset={paginationOffset}")
@Headers({
"Accept: application/json",
})
ApiResponse getSuccessfullySentChangeEventsForAlertByNameWithHttpInfo(@Param("eventSubscriptionName") String eventSubscriptionName, @Param("limit") Long limit, @Param("paginationOffset") Long paginationOffset);
/**
* Get successfully sent change events for an alert by name
* Retrieve successfully sent change events for a specific alert, identified by its name, with an optional limit.
* Note, this is equivalent to the other getSuccessfullySentChangeEventsForAlertByName method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link GetSuccessfullySentChangeEventsForAlertByNameQueryParams} class that allows for
* building up this map in a fluent style.
* @param eventSubscriptionName Name of the alert to retrieve change events for (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - limit - Maximum number of change events to retrieve (optional, default to 15)
* - paginationOffset - Offset for pagination (starting point for records) (optional, default to 0)
*
* @return ChangeEvent
*/
@RequestLine("GET /v1/events/subscriptions/name/{eventSubscriptionName}/listSuccessfullySentChangeEvents?limit={limit}&paginationOffset={paginationOffset}")
@Headers({
"Accept: application/json",
})
ChangeEvent getSuccessfullySentChangeEventsForAlertByName(@Param("eventSubscriptionName") String eventSubscriptionName, @QueryMap(encoded=true) GetSuccessfullySentChangeEventsForAlertByNameQueryParams queryParams);
/**
* Get successfully sent change events for an alert by name
* Retrieve successfully sent change events for a specific alert, identified by its name, with an optional limit.
* Note, this is equivalent to the other getSuccessfullySentChangeEventsForAlertByName that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param eventSubscriptionName Name of the alert to retrieve change events for (required)
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - limit - Maximum number of change events to retrieve (optional, default to 15)
* - paginationOffset - Offset for pagination (starting point for records) (optional, default to 0)
*
* @return ChangeEvent
*/
@RequestLine("GET /v1/events/subscriptions/name/{eventSubscriptionName}/listSuccessfullySentChangeEvents?limit={limit}&paginationOffset={paginationOffset}")
@Headers({
"Accept: application/json",
})
ApiResponse getSuccessfullySentChangeEventsForAlertByNameWithHttpInfo(@Param("eventSubscriptionName") String eventSubscriptionName, @QueryMap(encoded=true) GetSuccessfullySentChangeEventsForAlertByNameQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* getSuccessfullySentChangeEventsForAlertByName method in a fluent style.
*/
public static class GetSuccessfullySentChangeEventsForAlertByNameQueryParams extends HashMap {
public GetSuccessfullySentChangeEventsForAlertByNameQueryParams limit(final Long value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public GetSuccessfullySentChangeEventsForAlertByNameQueryParams paginationOffset(final Long value) {
put("paginationOffset", EncodingUtils.encode(value));
return this;
}
}
/**
* List Event Subscription versions
* Get a list of all the versions of an Event Subscription identified by `Id`
* @param id Id of the Event Subscription (required)
* @return EntityHistory
*/
@RequestLine("GET /v1/events/subscriptions/{id}/versions")
@Headers({
"Accept: application/json",
})
EntityHistory listAllEventSubscriptionVersion(@Param("id") UUID id);
/**
* List Event Subscription versions
* Similar to listAllEventSubscriptionVersion but it also returns the http response headers .
* Get a list of all the versions of an Event Subscription identified by `Id`
* @param id Id of the Event Subscription (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/events/subscriptions/{id}/versions")
@Headers({
"Accept: application/json",
})
ApiResponse listAllEventSubscriptionVersionWithHttpInfo(@Param("id") UUID id);
/**
* Get change events
* Get a list of change events matching event types, entity type, from a given date
* @param timestamp Events starting from this unix timestamp in milliseconds (required)
* @param entityCreated List of comma separated entities requested for `entityCreated` event. When set to `*` all entities will be returned (optional)
* @param entityUpdated List of comma separated entities requested for `entityUpdated` event. When set to `*` all entities will be returned (optional)
* @param entityRestored List of comma separated entities requested for `entityRestored` event. When set to `*` all entities will be returned (optional)
* @param entityDeleted List of comma separated entities requested for `entityCreated` event. When set to `*` all entities will be returned (optional)
* @return EventList
*/
@RequestLine("GET /v1/events?entityCreated={entityCreated}&entityUpdated={entityUpdated}&entityRestored={entityRestored}&entityDeleted={entityDeleted}×tamp={timestamp}")
@Headers({
"Accept: application/json",
})
EventList listChangeEvents(@Param("timestamp") Long timestamp, @Param("entityCreated") String entityCreated, @Param("entityUpdated") String entityUpdated, @Param("entityRestored") String entityRestored, @Param("entityDeleted") String entityDeleted);
/**
* Get change events
* Similar to listChangeEvents but it also returns the http response headers .
* Get a list of change events matching event types, entity type, from a given date
* @param timestamp Events starting from this unix timestamp in milliseconds (required)
* @param entityCreated List of comma separated entities requested for `entityCreated` event. When set to `*` all entities will be returned (optional)
* @param entityUpdated List of comma separated entities requested for `entityUpdated` event. When set to `*` all entities will be returned (optional)
* @param entityRestored List of comma separated entities requested for `entityRestored` event. When set to `*` all entities will be returned (optional)
* @param entityDeleted List of comma separated entities requested for `entityCreated` event. When set to `*` all entities will be returned (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/events?entityCreated={entityCreated}&entityUpdated={entityUpdated}&entityRestored={entityRestored}&entityDeleted={entityDeleted}×tamp={timestamp}")
@Headers({
"Accept: application/json",
})
ApiResponse listChangeEventsWithHttpInfo(@Param("timestamp") Long timestamp, @Param("entityCreated") String entityCreated, @Param("entityUpdated") String entityUpdated, @Param("entityRestored") String entityRestored, @Param("entityDeleted") String entityDeleted);
/**
* Get change events
* Get a list of change events matching event types, entity type, from a given date
* Note, this is equivalent to the other listChangeEvents method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link ListChangeEventsQueryParams} class that allows for
* building up this map in a fluent style.
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - entityCreated - List of comma separated entities requested for `entityCreated` event. When set to `*` all entities will be returned (optional)
* - entityUpdated - List of comma separated entities requested for `entityUpdated` event. When set to `*` all entities will be returned (optional)
* - entityRestored - List of comma separated entities requested for `entityRestored` event. When set to `*` all entities will be returned (optional)
* - entityDeleted - List of comma separated entities requested for `entityCreated` event. When set to `*` all entities will be returned (optional)
* - timestamp - Events starting from this unix timestamp in milliseconds (required)
*
* @return EventList
*/
@RequestLine("GET /v1/events?entityCreated={entityCreated}&entityUpdated={entityUpdated}&entityRestored={entityRestored}&entityDeleted={entityDeleted}×tamp={timestamp}")
@Headers({
"Accept: application/json",
})
EventList listChangeEvents(@QueryMap(encoded=true) ListChangeEventsQueryParams queryParams);
/**
* Get change events
* Get a list of change events matching event types, entity type, from a given date
* Note, this is equivalent to the other listChangeEvents that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - entityCreated - List of comma separated entities requested for `entityCreated` event. When set to `*` all entities will be returned (optional)
* - entityUpdated - List of comma separated entities requested for `entityUpdated` event. When set to `*` all entities will be returned (optional)
* - entityRestored - List of comma separated entities requested for `entityRestored` event. When set to `*` all entities will be returned (optional)
* - entityDeleted - List of comma separated entities requested for `entityCreated` event. When set to `*` all entities will be returned (optional)
* - timestamp - Events starting from this unix timestamp in milliseconds (required)
*
* @return EventList
*/
@RequestLine("GET /v1/events?entityCreated={entityCreated}&entityUpdated={entityUpdated}&entityRestored={entityRestored}&entityDeleted={entityDeleted}×tamp={timestamp}")
@Headers({
"Accept: application/json",
})
ApiResponse listChangeEventsWithHttpInfo(@QueryMap(encoded=true) ListChangeEventsQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* listChangeEvents method in a fluent style.
*/
public static class ListChangeEventsQueryParams extends HashMap {
public ListChangeEventsQueryParams entityCreated(final String value) {
put("entityCreated", EncodingUtils.encode(value));
return this;
}
public ListChangeEventsQueryParams entityUpdated(final String value) {
put("entityUpdated", EncodingUtils.encode(value));
return this;
}
public ListChangeEventsQueryParams entityRestored(final String value) {
put("entityRestored", EncodingUtils.encode(value));
return this;
}
public ListChangeEventsQueryParams entityDeleted(final String value) {
put("entityDeleted", EncodingUtils.encode(value));
return this;
}
public ListChangeEventsQueryParams timestamp(final Long value) {
put("timestamp", EncodingUtils.encode(value));
return this;
}
}
/**
* Get list of Event Subscriptions Resources used in filtering Event Subscription
* Get list of EventSubscription functions used in filtering conditions in Event Subscription
* @param alertType AlertType (required)
* @return ResultListFilterResourceDescriptor
*/
@RequestLine("GET /v1/events/subscriptions/{alertType}/resources")
@Headers({
"Accept: application/json",
})
ResultListFilterResourceDescriptor listEventSubscriptionResources(@Param("alertType") String alertType);
/**
* Get list of Event Subscriptions Resources used in filtering Event Subscription
* Similar to listEventSubscriptionResources but it also returns the http response headers .
* Get list of EventSubscription functions used in filtering conditions in Event Subscription
* @param alertType AlertType (required)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/events/subscriptions/{alertType}/resources")
@Headers({
"Accept: application/json",
})
ApiResponse listEventSubscriptionResourcesWithHttpInfo(@Param("alertType") String alertType);
/**
* List all available Event Subscriptions
* Get a list of All available Event Subscriptions
* @param fields Fields requested in the returned resource (optional)
* @param limit Limit the number event subscriptions returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param alertType alertType filter. Notification / Observability (optional)
* @param before Returns list of event subscriptions before this cursor (optional)
* @param after Returns list of event subscriptions after this cursor (optional)
* @return EventSubscriptionList
*/
@RequestLine("GET /v1/events/subscriptions?fields={fields}&limit={limit}&alertType={alertType}&before={before}&after={after}")
@Headers({
"Accept: application/json",
})
EventSubscriptionList listEventSubscriptions(@Param("fields") String fields, @Param("limit") Integer limit, @Param("alertType") String alertType, @Param("before") String before, @Param("after") String after);
/**
* List all available Event Subscriptions
* Similar to listEventSubscriptions but it also returns the http response headers .
* Get a list of All available Event Subscriptions
* @param fields Fields requested in the returned resource (optional)
* @param limit Limit the number event subscriptions returned. (1 to 1000000, default = 10) (optional, default to 10)
* @param alertType alertType filter. Notification / Observability (optional)
* @param before Returns list of event subscriptions before this cursor (optional)
* @param after Returns list of event subscriptions after this cursor (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("GET /v1/events/subscriptions?fields={fields}&limit={limit}&alertType={alertType}&before={before}&after={after}")
@Headers({
"Accept: application/json",
})
ApiResponse listEventSubscriptionsWithHttpInfo(@Param("fields") String fields, @Param("limit") Integer limit, @Param("alertType") String alertType, @Param("before") String before, @Param("after") String after);
/**
* List all available Event Subscriptions
* Get a list of All available Event Subscriptions
* Note, this is equivalent to the other listEventSubscriptions method,
* but with the query parameters collected into a single Map parameter. This
* is convenient for services with optional query parameters, especially when
* used with the {@link ListEventSubscriptionsQueryParams} class that allows for
* building up this map in a fluent style.
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - limit - Limit the number event subscriptions returned. (1 to 1000000, default = 10) (optional, default to 10)
* - alertType - alertType filter. Notification / Observability (optional)
* - before - Returns list of event subscriptions before this cursor (optional)
* - after - Returns list of event subscriptions after this cursor (optional)
*
* @return EventSubscriptionList
*/
@RequestLine("GET /v1/events/subscriptions?fields={fields}&limit={limit}&alertType={alertType}&before={before}&after={after}")
@Headers({
"Accept: application/json",
})
EventSubscriptionList listEventSubscriptions(@QueryMap(encoded=true) ListEventSubscriptionsQueryParams queryParams);
/**
* List all available Event Subscriptions
* Get a list of All available Event Subscriptions
* Note, this is equivalent to the other listEventSubscriptions that receives the query parameters as a map,
* but this one also exposes the Http response headers
* @param queryParams Map of query parameters as name-value pairs
* The following elements may be specified in the query map:
*
* - fields - Fields requested in the returned resource (optional)
* - limit - Limit the number event subscriptions returned. (1 to 1000000, default = 10) (optional, default to 10)
* - alertType - alertType filter. Notification / Observability (optional)
* - before - Returns list of event subscriptions before this cursor (optional)
* - after - Returns list of event subscriptions after this cursor (optional)
*
* @return EventSubscriptionList
*/
@RequestLine("GET /v1/events/subscriptions?fields={fields}&limit={limit}&alertType={alertType}&before={before}&after={after}")
@Headers({
"Accept: application/json",
})
ApiResponse listEventSubscriptionsWithHttpInfo(@QueryMap(encoded=true) ListEventSubscriptionsQueryParams queryParams);
/**
* A convenience class for generating query parameters for the
* listEventSubscriptions method in a fluent style.
*/
public static class ListEventSubscriptionsQueryParams extends HashMap {
public ListEventSubscriptionsQueryParams fields(final String value) {
put("fields", EncodingUtils.encode(value));
return this;
}
public ListEventSubscriptionsQueryParams limit(final Integer value) {
put("limit", EncodingUtils.encode(value));
return this;
}
public ListEventSubscriptionsQueryParams alertType(final String value) {
put("alertType", EncodingUtils.encode(value));
return this;
}
public ListEventSubscriptionsQueryParams before(final String value) {
put("before", EncodingUtils.encode(value));
return this;
}
public ListEventSubscriptionsQueryParams after(final String value) {
put("after", EncodingUtils.encode(value));
return this;
}
}
/**
* Update an Event Subscriptions by name.
* Update an existing Event Subscriptions using JsonPatch.
* @param fqn Name of the event Subscription (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update an Event Subscriptions by name. Documentation
*/
@RequestLine("PATCH /v1/events/subscriptions/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchEventSubscription(@Param("fqn") String fqn, Object body);
/**
* Update an Event Subscriptions by name.
* Similar to patchEventSubscription but it also returns the http response headers .
* Update an existing Event Subscriptions using JsonPatch.
* @param fqn Name of the event Subscription (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update an Event Subscriptions by name. Documentation
*/
@RequestLine("PATCH /v1/events/subscriptions/name/{fqn}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchEventSubscriptionWithHttpInfo(@Param("fqn") String fqn, Object body);
/**
* Update an Event Subscriptions
* Update an existing Event Subscriptions using JsonPatch.
* @param id Id of the event Subscription (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update an Event Subscriptions Documentation
*/
@RequestLine("PATCH /v1/events/subscriptions/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
void patchEventSubscription1(@Param("id") UUID id, Object body);
/**
* Update an Event Subscriptions
* Similar to patchEventSubscription1 but it also returns the http response headers .
* Update an existing Event Subscriptions using JsonPatch.
* @param id Id of the event Subscription (required)
* @param body JsonPatch with array of operations (optional)
* JsonPatch RFC
* @see Update an Event Subscriptions Documentation
*/
@RequestLine("PATCH /v1/events/subscriptions/{id}")
@Headers({
"Content-Type: application/json-patch+json",
"Accept: application/json",
})
ApiResponse patchEventSubscription1WithHttpInfo(@Param("id") UUID id, Object body);
/**
* Send a test message alert to external destinations.
* Send a test message alert to external destinations of the alert.
* @param eventSubscriptionDestinationTestRequest (optional)
* @return ConfigureApplication200Response
*/
@RequestLine("POST /v1/events/subscriptions/testDestination")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ConfigureApplication200Response testDestination(EventSubscriptionDestinationTestRequest eventSubscriptionDestinationTestRequest);
/**
* Send a test message alert to external destinations.
* Similar to testDestination but it also returns the http response headers .
* Send a test message alert to external destinations of the alert.
* @param eventSubscriptionDestinationTestRequest (optional)
* @return A ApiResponse that wraps the response boyd and the http headers.
*/
@RequestLine("POST /v1/events/subscriptions/testDestination")
@Headers({
"Content-Type: application/json",
"Accept: application/json",
})
ApiResponse testDestinationWithHttpInfo(EventSubscriptionDestinationTestRequest eventSubscriptionDestinationTestRequest);
/**
* Validate a given condition
* Validate a given condition expression used in filtering rules.
* @param expression Expression to validate (required)
*/
@RequestLine("GET /v1/events/subscriptions/validation/condition/{expression}")
@Headers({
"Accept: application/json",
})
void validateCondition(@Param("expression") String expression);
/**
* Validate a given condition
* Similar to validateCondition but it also returns the http response headers .
* Validate a given condition expression used in filtering rules.
* @param expression Expression to validate (required)
*/
@RequestLine("GET /v1/events/subscriptions/validation/condition/{expression}")
@Headers({
"Accept: application/json",
})
ApiResponse validateConditionWithHttpInfo(@Param("expression") String expression);
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy