Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

@rhoas/kafka-instance-sdk

Package Overview
Dependencies
Maintainers
5
Versions
88
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

@rhoas/kafka-instance-sdk - npm Package Compare versions

Comparing version 0.5.1 to 0.6.0-dev

dist/generated/model/consumer-group-reset-offset-parameters.d.ts

143

dist/generated/api/default-api.d.ts

@@ -17,2 +17,3 @@ /**

import { ConsumerGroupList } from '../model';
import { ConsumerGroupResetOffsetParameters } from '../model';
import { NewTopicInput } from '../model';

@@ -63,10 +64,14 @@ import { Topic } from '../model';

* @summary List of consumer groups in the Kafka instance.
* @param {number} [limit] Maximum number of consumer groups to returnd
* @param {number} [offset] The page offset when returning the list of consumer groups
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of consumer groups to return
* @param {number} [size] Maximum number of consumer groups to return on single page
* @param {number} [page] The page when returning the list of consumer groups
* @param {string} [topic] Return consumer groups for this topic
* @param {string} [groupIdFilter] Return the consumer groups where the ID begins with this value
* @param {'asc' | 'desc'} [order] Order of the consumer groups sorting. Ascending order is used as default.
* @param {'name'} [orderKey] Order key to sort the items by. Only the value \'name\' is currently applicable.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getConsumerGroups: (limit?: number, offset?: number, topic?: string, groupIdFilter?: string, options?: any) => Promise<RequestArgs>;
getConsumerGroups: (offset?: number, limit?: number, size?: number, page?: number, topic?: string, groupIdFilter?: string, order?: 'asc' | 'desc', orderKey?: 'name', options?: any) => Promise<RequestArgs>;
/**

@@ -83,11 +88,23 @@ * Topic

* @summary List of topics
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of topics to return
* @param {number} [size] Maximum number of topics to return on single page
* @param {string} [filter] Filter to apply when returning the list of topics
* @param {number} [offset] The page offset when returning the limit of requested topics.
* @param {string} [order] Order of the items sorting. If \&quot;asc\&quot; is set as a value, ascending order is used, descending otherwise.
* @param {number} [page] The page when returning the limit of requested topics.
* @param {'asc' | 'desc'} [order] Order of the items sorting. Ascending order is used as default.
* @param {'name' | 'partitions' | 'retention.ms' | 'retention.bytes'} [orderKey] Order key to sort the topics by.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTopics: (limit?: number, filter?: string, offset?: number, order?: string, options?: any) => Promise<RequestArgs>;
getTopics: (offset?: number, limit?: number, size?: number, filter?: string, page?: number, order?: 'asc' | 'desc', orderKey?: 'name' | 'partitions' | 'retention.ms' | 'retention.bytes', options?: any) => Promise<RequestArgs>;
/**
* Reset the offset for a particular consumer group.
* @summary Reset the offset for a consumer group.
* @param {string} consumerGroupId The ID of the consumer group.
* @param {ConsumerGroupResetOffsetParameters} consumerGroupResetOffsetParameters
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
resetConsumerGroupOffset: (consumerGroupId: string, consumerGroupResetOffsetParameters: ConsumerGroupResetOffsetParameters, options?: any) => Promise<RequestArgs>;
/**
* updates the topic with the new data.

@@ -143,10 +160,14 @@ * @summary Updates the topic with the specified name.

* @summary List of consumer groups in the Kafka instance.
* @param {number} [limit] Maximum number of consumer groups to returnd
* @param {number} [offset] The page offset when returning the list of consumer groups
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of consumer groups to return
* @param {number} [size] Maximum number of consumer groups to return on single page
* @param {number} [page] The page when returning the list of consumer groups
* @param {string} [topic] Return consumer groups for this topic
* @param {string} [groupIdFilter] Return the consumer groups where the ID begins with this value
* @param {'asc' | 'desc'} [order] Order of the consumer groups sorting. Ascending order is used as default.
* @param {'name'} [orderKey] Order key to sort the items by. Only the value \&#39;name\&#39; is currently applicable.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getConsumerGroups(limit?: number, offset?: number, topic?: string, groupIdFilter?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConsumerGroupList>>;
getConsumerGroups(offset?: number, limit?: number, size?: number, page?: number, topic?: string, groupIdFilter?: string, order?: 'asc' | 'desc', orderKey?: 'name', options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConsumerGroupList>>;
/**

@@ -163,11 +184,23 @@ * Topic

* @summary List of topics
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of topics to return
* @param {number} [size] Maximum number of topics to return on single page
* @param {string} [filter] Filter to apply when returning the list of topics
* @param {number} [offset] The page offset when returning the limit of requested topics.
* @param {string} [order] Order of the items sorting. If \&quot;asc\&quot; is set as a value, ascending order is used, descending otherwise.
* @param {number} [page] The page when returning the limit of requested topics.
* @param {'asc' | 'desc'} [order] Order of the items sorting. Ascending order is used as default.
* @param {'name' | 'partitions' | 'retention.ms' | 'retention.bytes'} [orderKey] Order key to sort the topics by.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTopics(limit?: number, filter?: string, offset?: number, order?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TopicsList>>;
getTopics(offset?: number, limit?: number, size?: number, filter?: string, page?: number, order?: 'asc' | 'desc', orderKey?: 'name' | 'partitions' | 'retention.ms' | 'retention.bytes', options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TopicsList>>;
/**
* Reset the offset for a particular consumer group.
* @summary Reset the offset for a consumer group.
* @param {string} consumerGroupId The ID of the consumer group.
* @param {ConsumerGroupResetOffsetParameters} consumerGroupResetOffsetParameters
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
resetConsumerGroupOffset(consumerGroupId: string, consumerGroupResetOffsetParameters: ConsumerGroupResetOffsetParameters, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Array<object>>>>;
/**
* updates the topic with the new data.

@@ -223,10 +256,14 @@ * @summary Updates the topic with the specified name.

* @summary List of consumer groups in the Kafka instance.
* @param {number} [limit] Maximum number of consumer groups to returnd
* @param {number} [offset] The page offset when returning the list of consumer groups
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of consumer groups to return
* @param {number} [size] Maximum number of consumer groups to return on single page
* @param {number} [page] The page when returning the list of consumer groups
* @param {string} [topic] Return consumer groups for this topic
* @param {string} [groupIdFilter] Return the consumer groups where the ID begins with this value
* @param {'asc' | 'desc'} [order] Order of the consumer groups sorting. Ascending order is used as default.
* @param {'name'} [orderKey] Order key to sort the items by. Only the value \&#39;name\&#39; is currently applicable.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getConsumerGroups(limit?: number, offset?: number, topic?: string, groupIdFilter?: string, options?: any): AxiosPromise<ConsumerGroupList>;
getConsumerGroups(offset?: number, limit?: number, size?: number, page?: number, topic?: string, groupIdFilter?: string, order?: 'asc' | 'desc', orderKey?: 'name', options?: any): AxiosPromise<ConsumerGroupList>;
/**

@@ -243,11 +280,23 @@ * Topic

* @summary List of topics
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of topics to return
* @param {number} [size] Maximum number of topics to return on single page
* @param {string} [filter] Filter to apply when returning the list of topics
* @param {number} [offset] The page offset when returning the limit of requested topics.
* @param {string} [order] Order of the items sorting. If \&quot;asc\&quot; is set as a value, ascending order is used, descending otherwise.
* @param {number} [page] The page when returning the limit of requested topics.
* @param {'asc' | 'desc'} [order] Order of the items sorting. Ascending order is used as default.
* @param {'name' | 'partitions' | 'retention.ms' | 'retention.bytes'} [orderKey] Order key to sort the topics by.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTopics(limit?: number, filter?: string, offset?: number, order?: string, options?: any): AxiosPromise<TopicsList>;
getTopics(offset?: number, limit?: number, size?: number, filter?: string, page?: number, order?: 'asc' | 'desc', orderKey?: 'name' | 'partitions' | 'retention.ms' | 'retention.bytes', options?: any): AxiosPromise<TopicsList>;
/**
* Reset the offset for a particular consumer group.
* @summary Reset the offset for a consumer group.
* @param {string} consumerGroupId The ID of the consumer group.
* @param {ConsumerGroupResetOffsetParameters} consumerGroupResetOffsetParameters
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
resetConsumerGroupOffset(consumerGroupId: string, consumerGroupResetOffsetParameters: ConsumerGroupResetOffsetParameters, options?: any): AxiosPromise<Array<Array<object>>>;
/**
* updates the topic with the new data.

@@ -308,6 +357,10 @@ * @summary Updates the topic with the specified name.

* @summary List of consumer groups in the Kafka instance.
* @param {number} [limit] Maximum number of consumer groups to returnd
* @param {number} [offset] The page offset when returning the list of consumer groups
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of consumer groups to return
* @param {number} [size] Maximum number of consumer groups to return on single page
* @param {number} [page] The page when returning the list of consumer groups
* @param {string} [topic] Return consumer groups for this topic
* @param {string} [groupIdFilter] Return the consumer groups where the ID begins with this value
* @param {'asc' | 'desc'} [order] Order of the consumer groups sorting. Ascending order is used as default.
* @param {'name'} [orderKey] Order key to sort the items by. Only the value \&#39;name\&#39; is currently applicable.
* @param {*} [options] Override http request option.

@@ -317,3 +370,3 @@ * @throws {RequiredError}

*/
getConsumerGroups(limit?: number, offset?: number, topic?: string, groupIdFilter?: string, options?: any): AxiosPromise<ConsumerGroupList>;
getConsumerGroups(offset?: number, limit?: number, size?: number, page?: number, topic?: string, groupIdFilter?: string, order?: 'asc' | 'desc', orderKey?: 'name', options?: any): AxiosPromise<ConsumerGroupList>;
/**

@@ -331,6 +384,9 @@ * Topic

* @summary List of topics
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of topics to return
* @param {number} [size] Maximum number of topics to return on single page
* @param {string} [filter] Filter to apply when returning the list of topics
* @param {number} [offset] The page offset when returning the limit of requested topics.
* @param {string} [order] Order of the items sorting. If \&quot;asc\&quot; is set as a value, ascending order is used, descending otherwise.
* @param {number} [page] The page when returning the limit of requested topics.
* @param {'asc' | 'desc'} [order] Order of the items sorting. Ascending order is used as default.
* @param {'name' | 'partitions' | 'retention.ms' | 'retention.bytes'} [orderKey] Order key to sort the topics by.
* @param {*} [options] Override http request option.

@@ -340,4 +396,14 @@ * @throws {RequiredError}

*/
getTopics(limit?: number, filter?: string, offset?: number, order?: string, options?: any): AxiosPromise<TopicsList>;
getTopics(offset?: number, limit?: number, size?: number, filter?: string, page?: number, order?: 'asc' | 'desc', orderKey?: 'name' | 'partitions' | 'retention.ms' | 'retention.bytes', options?: any): AxiosPromise<TopicsList>;
/**
* Reset the offset for a particular consumer group.
* @summary Reset the offset for a consumer group.
* @param {string} consumerGroupId The ID of the consumer group.
* @param {ConsumerGroupResetOffsetParameters} consumerGroupResetOffsetParameters
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DefaultApiInterface
*/
resetConsumerGroupOffset(consumerGroupId: string, consumerGroupResetOffsetParameters: ConsumerGroupResetOffsetParameters, options?: any): AxiosPromise<Array<Array<object>>>;
/**
* updates the topic with the new data.

@@ -400,6 +466,10 @@ * @summary Updates the topic with the specified name.

* @summary List of consumer groups in the Kafka instance.
* @param {number} [limit] Maximum number of consumer groups to returnd
* @param {number} [offset] The page offset when returning the list of consumer groups
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of consumer groups to return
* @param {number} [size] Maximum number of consumer groups to return on single page
* @param {number} [page] The page when returning the list of consumer groups
* @param {string} [topic] Return consumer groups for this topic
* @param {string} [groupIdFilter] Return the consumer groups where the ID begins with this value
* @param {'asc' | 'desc'} [order] Order of the consumer groups sorting. Ascending order is used as default.
* @param {'name'} [orderKey] Order key to sort the items by. Only the value \&#39;name\&#39; is currently applicable.
* @param {*} [options] Override http request option.

@@ -409,3 +479,3 @@ * @throws {RequiredError}

*/
getConsumerGroups(limit?: number, offset?: number, topic?: string, groupIdFilter?: string, options?: any): Promise<import("axios").AxiosResponse<ConsumerGroupList>>;
getConsumerGroups(offset?: number, limit?: number, size?: number, page?: number, topic?: string, groupIdFilter?: string, order?: 'asc' | 'desc', orderKey?: 'name', options?: any): Promise<import("axios").AxiosResponse<ConsumerGroupList>>;
/**

@@ -423,6 +493,9 @@ * Topic

* @summary List of topics
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of topics to return
* @param {number} [size] Maximum number of topics to return on single page
* @param {string} [filter] Filter to apply when returning the list of topics
* @param {number} [offset] The page offset when returning the limit of requested topics.
* @param {string} [order] Order of the items sorting. If \&quot;asc\&quot; is set as a value, ascending order is used, descending otherwise.
* @param {number} [page] The page when returning the limit of requested topics.
* @param {'asc' | 'desc'} [order] Order of the items sorting. Ascending order is used as default.
* @param {'name' | 'partitions' | 'retention.ms' | 'retention.bytes'} [orderKey] Order key to sort the topics by.
* @param {*} [options] Override http request option.

@@ -432,4 +505,14 @@ * @throws {RequiredError}

*/
getTopics(limit?: number, filter?: string, offset?: number, order?: string, options?: any): Promise<import("axios").AxiosResponse<TopicsList>>;
getTopics(offset?: number, limit?: number, size?: number, filter?: string, page?: number, order?: 'asc' | 'desc', orderKey?: 'name' | 'partitions' | 'retention.ms' | 'retention.bytes', options?: any): Promise<import("axios").AxiosResponse<TopicsList>>;
/**
* Reset the offset for a particular consumer group.
* @summary Reset the offset for a consumer group.
* @param {string} consumerGroupId The ID of the consumer group.
* @param {ConsumerGroupResetOffsetParameters} consumerGroupResetOffsetParameters
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DefaultApi
*/
resetConsumerGroupOffset(consumerGroupId: string, consumerGroupResetOffsetParameters: ConsumerGroupResetOffsetParameters, options?: any): Promise<import("axios").AxiosResponse<object[][]>>;
/**
* updates the topic with the new data.

@@ -436,0 +519,0 @@ * @summary Updates the topic with the specified name.

@@ -174,10 +174,14 @@ "use strict";

* @summary List of consumer groups in the Kafka instance.
* @param {number} [limit] Maximum number of consumer groups to returnd
* @param {number} [offset] The page offset when returning the list of consumer groups
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of consumer groups to return
* @param {number} [size] Maximum number of consumer groups to return on single page
* @param {number} [page] The page when returning the list of consumer groups
* @param {string} [topic] Return consumer groups for this topic
* @param {string} [groupIdFilter] Return the consumer groups where the ID begins with this value
* @param {'asc' | 'desc'} [order] Order of the consumer groups sorting. Ascending order is used as default.
* @param {'name'} [orderKey] Order key to sort the items by. Only the value \&#39;name\&#39; is currently applicable.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getConsumerGroups: (limit, offset, topic, groupIdFilter, options = {}) => __awaiter(this, void 0, void 0, function* () {
getConsumerGroups: (offset, limit, size, page, topic, groupIdFilter, order, orderKey, options = {}) => __awaiter(this, void 0, void 0, function* () {
const localVarPath = `/consumer-groups`;

@@ -196,8 +200,14 @@ // use dummy base URL string because the URL constructor only accepts absolute URLs.

yield common_1.setOAuthToObject(localVarHeaderParameter, "Bearer", [], configuration);
if (offset !== undefined) {
localVarQueryParameter['offset'] = offset;
}
if (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}
if (offset !== undefined) {
localVarQueryParameter['offset'] = offset;
if (size !== undefined) {
localVarQueryParameter['size'] = size;
}
if (page !== undefined) {
localVarQueryParameter['page'] = page;
}
if (topic !== undefined) {

@@ -209,2 +219,8 @@ localVarQueryParameter['topic'] = topic;

}
if (order !== undefined) {
localVarQueryParameter['order'] = order;
}
if (orderKey !== undefined) {
localVarQueryParameter['orderKey'] = orderKey;
}
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);

@@ -253,10 +269,13 @@ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};

* @summary List of topics
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of topics to return
* @param {number} [size] Maximum number of topics to return on single page
* @param {string} [filter] Filter to apply when returning the list of topics
* @param {number} [offset] The page offset when returning the limit of requested topics.
* @param {string} [order] Order of the items sorting. If \&quot;asc\&quot; is set as a value, ascending order is used, descending otherwise.
* @param {number} [page] The page when returning the limit of requested topics.
* @param {'asc' | 'desc'} [order] Order of the items sorting. Ascending order is used as default.
* @param {'name' | 'partitions' | 'retention.ms' | 'retention.bytes'} [orderKey] Order key to sort the topics by.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTopics: (limit, filter, offset, order, options = {}) => __awaiter(this, void 0, void 0, function* () {
getTopics: (offset, limit, size, filter, page, order, orderKey, options = {}) => __awaiter(this, void 0, void 0, function* () {
const localVarPath = `/topics`;

@@ -275,10 +294,16 @@ // use dummy base URL string because the URL constructor only accepts absolute URLs.

yield common_1.setOAuthToObject(localVarHeaderParameter, "Bearer", [], configuration);
if (offset !== undefined) {
localVarQueryParameter['offset'] = offset;
}
if (limit !== undefined) {
localVarQueryParameter['limit'] = limit;
}
if (size !== undefined) {
localVarQueryParameter['size'] = size;
}
if (filter !== undefined) {
localVarQueryParameter['filter'] = filter;
}
if (offset !== undefined) {
localVarQueryParameter['offset'] = offset;
if (page !== undefined) {
localVarQueryParameter['page'] = page;
}

@@ -288,2 +313,5 @@ if (order !== undefined) {

}
if (orderKey !== undefined) {
localVarQueryParameter['orderKey'] = orderKey;
}
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);

@@ -298,2 +326,39 @@ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};

/**
* Reset the offset for a particular consumer group.
* @summary Reset the offset for a consumer group.
* @param {string} consumerGroupId The ID of the consumer group.
* @param {ConsumerGroupResetOffsetParameters} consumerGroupResetOffsetParameters
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
resetConsumerGroupOffset: (consumerGroupId, consumerGroupResetOffsetParameters, options = {}) => __awaiter(this, void 0, void 0, function* () {
// verify required parameter 'consumerGroupId' is not null or undefined
common_1.assertParamExists('resetConsumerGroupOffset', 'consumerGroupId', consumerGroupId);
// verify required parameter 'consumerGroupResetOffsetParameters' is not null or undefined
common_1.assertParamExists('resetConsumerGroupOffset', 'consumerGroupResetOffsetParameters', consumerGroupResetOffsetParameters);
const localVarPath = `/consumer-groups/{consumerGroupId}/reset-offset`
.replace(`{${"consumerGroupId"}}`, encodeURIComponent(String(consumerGroupId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, common_1.DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = Object.assign(Object.assign({ method: 'POST' }, baseOptions), options);
const localVarHeaderParameter = {};
const localVarQueryParameter = {};
// authentication Bearer required
// oauth required
yield common_1.setOAuthToObject(localVarHeaderParameter, "Bearer", [], configuration);
localVarHeaderParameter['Content-Type'] = 'application/json';
common_1.setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = Object.assign(Object.assign(Object.assign({}, localVarHeaderParameter), headersFromBaseOptions), options.headers);
localVarRequestOptions.data = common_1.serializeDataIfNeeded(consumerGroupResetOffsetParameters, localVarRequestOptions, configuration);
return {
url: common_1.toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
}),
/**
* updates the topic with the new data.

@@ -401,12 +466,16 @@ * @summary Updates the topic with the specified name.

* @summary List of consumer groups in the Kafka instance.
* @param {number} [limit] Maximum number of consumer groups to returnd
* @param {number} [offset] The page offset when returning the list of consumer groups
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of consumer groups to return
* @param {number} [size] Maximum number of consumer groups to return on single page
* @param {number} [page] The page when returning the list of consumer groups
* @param {string} [topic] Return consumer groups for this topic
* @param {string} [groupIdFilter] Return the consumer groups where the ID begins with this value
* @param {'asc' | 'desc'} [order] Order of the consumer groups sorting. Ascending order is used as default.
* @param {'name'} [orderKey] Order key to sort the items by. Only the value \&#39;name\&#39; is currently applicable.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getConsumerGroups(limit, offset, topic, groupIdFilter, options) {
getConsumerGroups(offset, limit, size, page, topic, groupIdFilter, order, orderKey, options) {
return __awaiter(this, void 0, void 0, function* () {
const localVarAxiosArgs = yield localVarAxiosParamCreator.getConsumerGroups(limit, offset, topic, groupIdFilter, options);
const localVarAxiosArgs = yield localVarAxiosParamCreator.getConsumerGroups(offset, limit, size, page, topic, groupIdFilter, order, orderKey, options);
return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);

@@ -431,12 +500,15 @@ });

* @summary List of topics
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of topics to return
* @param {number} [size] Maximum number of topics to return on single page
* @param {string} [filter] Filter to apply when returning the list of topics
* @param {number} [offset] The page offset when returning the limit of requested topics.
* @param {string} [order] Order of the items sorting. If \&quot;asc\&quot; is set as a value, ascending order is used, descending otherwise.
* @param {number} [page] The page when returning the limit of requested topics.
* @param {'asc' | 'desc'} [order] Order of the items sorting. Ascending order is used as default.
* @param {'name' | 'partitions' | 'retention.ms' | 'retention.bytes'} [orderKey] Order key to sort the topics by.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTopics(limit, filter, offset, order, options) {
getTopics(offset, limit, size, filter, page, order, orderKey, options) {
return __awaiter(this, void 0, void 0, function* () {
const localVarAxiosArgs = yield localVarAxiosParamCreator.getTopics(limit, filter, offset, order, options);
const localVarAxiosArgs = yield localVarAxiosParamCreator.getTopics(offset, limit, size, filter, page, order, orderKey, options);
return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);

@@ -446,2 +518,16 @@ });

/**
* Reset the offset for a particular consumer group.
* @summary Reset the offset for a consumer group.
* @param {string} consumerGroupId The ID of the consumer group.
* @param {ConsumerGroupResetOffsetParameters} consumerGroupResetOffsetParameters
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
resetConsumerGroupOffset(consumerGroupId, consumerGroupResetOffsetParameters, options) {
return __awaiter(this, void 0, void 0, function* () {
const localVarAxiosArgs = yield localVarAxiosParamCreator.resetConsumerGroupOffset(consumerGroupId, consumerGroupResetOffsetParameters, options);
return common_1.createRequestFunction(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration);
});
},
/**
* updates the topic with the new data.

@@ -514,11 +600,15 @@ * @summary Updates the topic with the specified name.

* @summary List of consumer groups in the Kafka instance.
* @param {number} [limit] Maximum number of consumer groups to returnd
* @param {number} [offset] The page offset when returning the list of consumer groups
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of consumer groups to return
* @param {number} [size] Maximum number of consumer groups to return on single page
* @param {number} [page] The page when returning the list of consumer groups
* @param {string} [topic] Return consumer groups for this topic
* @param {string} [groupIdFilter] Return the consumer groups where the ID begins with this value
* @param {'asc' | 'desc'} [order] Order of the consumer groups sorting. Ascending order is used as default.
* @param {'name'} [orderKey] Order key to sort the items by. Only the value \&#39;name\&#39; is currently applicable.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getConsumerGroups(limit, offset, topic, groupIdFilter, options) {
return localVarFp.getConsumerGroups(limit, offset, topic, groupIdFilter, options).then((request) => request(axios, basePath));
getConsumerGroups(offset, limit, size, page, topic, groupIdFilter, order, orderKey, options) {
return localVarFp.getConsumerGroups(offset, limit, size, page, topic, groupIdFilter, order, orderKey, options).then((request) => request(axios, basePath));
},

@@ -538,13 +628,27 @@ /**

* @summary List of topics
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of topics to return
* @param {number} [size] Maximum number of topics to return on single page
* @param {string} [filter] Filter to apply when returning the list of topics
* @param {number} [offset] The page offset when returning the limit of requested topics.
* @param {string} [order] Order of the items sorting. If \&quot;asc\&quot; is set as a value, ascending order is used, descending otherwise.
* @param {number} [page] The page when returning the limit of requested topics.
* @param {'asc' | 'desc'} [order] Order of the items sorting. Ascending order is used as default.
* @param {'name' | 'partitions' | 'retention.ms' | 'retention.bytes'} [orderKey] Order key to sort the topics by.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTopics(limit, filter, offset, order, options) {
return localVarFp.getTopics(limit, filter, offset, order, options).then((request) => request(axios, basePath));
getTopics(offset, limit, size, filter, page, order, orderKey, options) {
return localVarFp.getTopics(offset, limit, size, filter, page, order, orderKey, options).then((request) => request(axios, basePath));
},
/**
* Reset the offset for a particular consumer group.
* @summary Reset the offset for a consumer group.
* @param {string} consumerGroupId The ID of the consumer group.
* @param {ConsumerGroupResetOffsetParameters} consumerGroupResetOffsetParameters
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
resetConsumerGroupOffset(consumerGroupId, consumerGroupResetOffsetParameters, options) {
return localVarFp.resetConsumerGroupOffset(consumerGroupId, consumerGroupResetOffsetParameters, options).then((request) => request(axios, basePath));
},
/**
* updates the topic with the new data.

@@ -618,6 +722,10 @@ * @summary Updates the topic with the specified name.

* @summary List of consumer groups in the Kafka instance.
* @param {number} [limit] Maximum number of consumer groups to returnd
* @param {number} [offset] The page offset when returning the list of consumer groups
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of consumer groups to return
* @param {number} [size] Maximum number of consumer groups to return on single page
* @param {number} [page] The page when returning the list of consumer groups
* @param {string} [topic] Return consumer groups for this topic
* @param {string} [groupIdFilter] Return the consumer groups where the ID begins with this value
* @param {'asc' | 'desc'} [order] Order of the consumer groups sorting. Ascending order is used as default.
* @param {'name'} [orderKey] Order key to sort the items by. Only the value \&#39;name\&#39; is currently applicable.
* @param {*} [options] Override http request option.

@@ -627,4 +735,4 @@ * @throws {RequiredError}

*/
getConsumerGroups(limit, offset, topic, groupIdFilter, options) {
return exports.DefaultApiFp(this.configuration).getConsumerGroups(limit, offset, topic, groupIdFilter, options).then((request) => request(this.axios, this.basePath));
getConsumerGroups(offset, limit, size, page, topic, groupIdFilter, order, orderKey, options) {
return exports.DefaultApiFp(this.configuration).getConsumerGroups(offset, limit, size, page, topic, groupIdFilter, order, orderKey, options).then((request) => request(this.axios, this.basePath));
}

@@ -645,6 +753,9 @@ /**

* @summary List of topics
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of topics to return
* @param {number} [size] Maximum number of topics to return on single page
* @param {string} [filter] Filter to apply when returning the list of topics
* @param {number} [offset] The page offset when returning the limit of requested topics.
* @param {string} [order] Order of the items sorting. If \&quot;asc\&quot; is set as a value, ascending order is used, descending otherwise.
* @param {number} [page] The page when returning the limit of requested topics.
* @param {'asc' | 'desc'} [order] Order of the items sorting. Ascending order is used as default.
* @param {'name' | 'partitions' | 'retention.ms' | 'retention.bytes'} [orderKey] Order key to sort the topics by.
* @param {*} [options] Override http request option.

@@ -654,6 +765,18 @@ * @throws {RequiredError}

*/
getTopics(limit, filter, offset, order, options) {
return exports.DefaultApiFp(this.configuration).getTopics(limit, filter, offset, order, options).then((request) => request(this.axios, this.basePath));
getTopics(offset, limit, size, filter, page, order, orderKey, options) {
return exports.DefaultApiFp(this.configuration).getTopics(offset, limit, size, filter, page, order, orderKey, options).then((request) => request(this.axios, this.basePath));
}
/**
* Reset the offset for a particular consumer group.
* @summary Reset the offset for a consumer group.
* @param {string} consumerGroupId The ID of the consumer group.
* @param {ConsumerGroupResetOffsetParameters} consumerGroupResetOffsetParameters
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DefaultApi
*/
resetConsumerGroupOffset(consumerGroupId, consumerGroupResetOffsetParameters, options) {
return exports.DefaultApiFp(this.configuration).resetConsumerGroupOffset(consumerGroupId, consumerGroupResetOffsetParameters, options).then((request) => request(this.axios, this.basePath));
}
/**
* updates the topic with the new data.

@@ -660,0 +783,0 @@ * @summary Updates the topic with the specified name.

@@ -24,3 +24,3 @@ /**

*/
items: Array<ConsumerGroup>;
items?: Array<ConsumerGroup>;
/**

@@ -31,3 +31,3 @@ * The total number of consumer groups.

*/
count: number;
total?: number;
/**

@@ -38,9 +38,21 @@ * The number of consumer groups per page.

*/
limit: number;
size?: number;
/**
* The page offset
* The page
* @type {number}
* @memberof ConsumerGroupList
*/
offset: number;
page?: number;
/**
* Deprecated offset of the topic list
* @type {number}
* @memberof ConsumerGroupList
*/
offset?: number;
/**
* Deprecated maximum of returned topics
* @type {number}
* @memberof ConsumerGroupList
*/
limit?: number;
}

@@ -5,2 +5,3 @@ export * from './config-entry';

export * from './consumer-group-list';
export * from './consumer-group-reset-offset-parameters';
export * from './new-topic-input';

@@ -11,2 +12,3 @@ export * from './partition';

export * from './topics-list';
export * from './topics-to-reset-offset';
export * from './update-topic-input';

@@ -17,2 +17,3 @@ "use strict";

__exportStar(require("./consumer-group-list"), exports);
__exportStar(require("./consumer-group-reset-offset-parameters"), exports);
__exportStar(require("./new-topic-input"), exports);

@@ -23,2 +24,3 @@ __exportStar(require("./partition"), exports);

__exportStar(require("./topics-list"), exports);
__exportStar(require("./topics-to-reset-offset"), exports);
__exportStar(require("./update-topic-input"), exports);

@@ -20,7 +20,7 @@ /**

/**
* The page offset
* The page
* @type {number}
* @memberof TopicsList
*/
offset: number;
page?: number;
/**

@@ -31,4 +31,16 @@ * number of entries per page

*/
limit: number;
size?: number;
/**
* Deprecated offset of the topic list
* @type {number}
* @memberof TopicsList
*/
offset?: number;
/**
* Deprecated maximum of returned topics
* @type {number}
* @memberof TopicsList
*/
limit?: number;
/**
* Total number of topics

@@ -38,3 +50,3 @@ * @type {number}

*/
count: number;
total?: number;
/**

@@ -45,3 +57,3 @@ * List of topics

*/
items: Array<Topic>;
items?: Array<Topic>;
}

@@ -20,3 +20,3 @@ /**

/**
* Topic configuration entry.
* Topic configuration entries.
* @type {Array<ConfigEntry>}

@@ -26,2 +26,8 @@ * @memberof UpdateTopicInput

config?: Array<ConfigEntry>;
/**
* Number of partitions (only increasing supported)
* @type {number}
* @memberof UpdateTopicInput
*/
partitions?: number;
}
{
"name": "@rhoas/kafka-instance-sdk",
"version": "0.5.1",
"version": "0.6.0-dev",
"description": "RHOAS Kafka Instance Adminstration SDK",

@@ -30,5 +30,5 @@ "author": "Red Hat Developers",

"devDependencies": {
"@types/node": "14.17.2",
"typescript": "4.3.2"
"@types/node": "14.17.4",
"typescript": "4.3.4"
}
}

@@ -28,2 +28,4 @@ /* tslint:disable */

// @ts-ignore
import { ConsumerGroupResetOffsetParameters } from '../model';
// @ts-ignore
import { NewTopicInput } from '../model';

@@ -204,10 +206,14 @@ // @ts-ignore

* @summary List of consumer groups in the Kafka instance.
* @param {number} [limit] Maximum number of consumer groups to returnd
* @param {number} [offset] The page offset when returning the list of consumer groups
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of consumer groups to return
* @param {number} [size] Maximum number of consumer groups to return on single page
* @param {number} [page] The page when returning the list of consumer groups
* @param {string} [topic] Return consumer groups for this topic
* @param {string} [groupIdFilter] Return the consumer groups where the ID begins with this value
* @param {'asc' | 'desc'} [order] Order of the consumer groups sorting. Ascending order is used as default.
* @param {'name'} [orderKey] Order key to sort the items by. Only the value \&#39;name\&#39; is currently applicable.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getConsumerGroups: async (limit?: number, offset?: number, topic?: string, groupIdFilter?: string, options: any = {}): Promise<RequestArgs> => {
getConsumerGroups: async (offset?: number, limit?: number, size?: number, page?: number, topic?: string, groupIdFilter?: string, order?: 'asc' | 'desc', orderKey?: 'name', options: any = {}): Promise<RequestArgs> => {
const localVarPath = `/consumer-groups`;

@@ -229,2 +235,6 @@ // use dummy base URL string because the URL constructor only accepts absolute URLs.

if (offset !== undefined) {
localVarQueryParameter['offset'] = offset;
}
if (limit !== undefined) {

@@ -234,6 +244,10 @@ localVarQueryParameter['limit'] = limit;

if (offset !== undefined) {
localVarQueryParameter['offset'] = offset;
if (size !== undefined) {
localVarQueryParameter['size'] = size;
}
if (page !== undefined) {
localVarQueryParameter['page'] = page;
}
if (topic !== undefined) {

@@ -247,3 +261,11 @@ localVarQueryParameter['topic'] = topic;

if (order !== undefined) {
localVarQueryParameter['order'] = order;
}
if (orderKey !== undefined) {
localVarQueryParameter['orderKey'] = orderKey;
}

@@ -300,10 +322,13 @@ setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);

* @summary List of topics
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of topics to return
* @param {number} [size] Maximum number of topics to return on single page
* @param {string} [filter] Filter to apply when returning the list of topics
* @param {number} [offset] The page offset when returning the limit of requested topics.
* @param {string} [order] Order of the items sorting. If \&quot;asc\&quot; is set as a value, ascending order is used, descending otherwise.
* @param {number} [page] The page when returning the limit of requested topics.
* @param {'asc' | 'desc'} [order] Order of the items sorting. Ascending order is used as default.
* @param {'name' | 'partitions' | 'retention.ms' | 'retention.bytes'} [orderKey] Order key to sort the topics by.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTopics: async (limit?: number, filter?: string, offset?: number, order?: string, options: any = {}): Promise<RequestArgs> => {
getTopics: async (offset?: number, limit?: number, size?: number, filter?: string, page?: number, order?: 'asc' | 'desc', orderKey?: 'name' | 'partitions' | 'retention.ms' | 'retention.bytes', options: any = {}): Promise<RequestArgs> => {
const localVarPath = `/topics`;

@@ -325,2 +350,6 @@ // use dummy base URL string because the URL constructor only accepts absolute URLs.

if (offset !== undefined) {
localVarQueryParameter['offset'] = offset;
}
if (limit !== undefined) {

@@ -330,2 +359,6 @@ localVarQueryParameter['limit'] = limit;

if (size !== undefined) {
localVarQueryParameter['size'] = size;
}
if (filter !== undefined) {

@@ -335,4 +368,4 @@ localVarQueryParameter['filter'] = filter;

if (offset !== undefined) {
localVarQueryParameter['offset'] = offset;
if (page !== undefined) {
localVarQueryParameter['page'] = page;
}

@@ -344,3 +377,7 @@

if (orderKey !== undefined) {
localVarQueryParameter['orderKey'] = orderKey;
}

@@ -357,2 +394,46 @@ setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);

/**
* Reset the offset for a particular consumer group.
* @summary Reset the offset for a consumer group.
* @param {string} consumerGroupId The ID of the consumer group.
* @param {ConsumerGroupResetOffsetParameters} consumerGroupResetOffsetParameters
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
resetConsumerGroupOffset: async (consumerGroupId: string, consumerGroupResetOffsetParameters: ConsumerGroupResetOffsetParameters, options: any = {}): Promise<RequestArgs> => {
// verify required parameter 'consumerGroupId' is not null or undefined
assertParamExists('resetConsumerGroupOffset', 'consumerGroupId', consumerGroupId)
// verify required parameter 'consumerGroupResetOffsetParameters' is not null or undefined
assertParamExists('resetConsumerGroupOffset', 'consumerGroupResetOffsetParameters', consumerGroupResetOffsetParameters)
const localVarPath = `/consumer-groups/{consumerGroupId}/reset-offset`
.replace(`{${"consumerGroupId"}}`, encodeURIComponent(String(consumerGroupId)));
// use dummy base URL string because the URL constructor only accepts absolute URLs.
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
let baseOptions;
if (configuration) {
baseOptions = configuration.baseOptions;
}
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
const localVarHeaderParameter = {} as any;
const localVarQueryParameter = {} as any;
// authentication Bearer required
// oauth required
await setOAuthToObject(localVarHeaderParameter, "Bearer", [], configuration)
localVarHeaderParameter['Content-Type'] = 'application/json';
setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
localVarRequestOptions.data = serializeDataIfNeeded(consumerGroupResetOffsetParameters, localVarRequestOptions, configuration)
return {
url: toPathString(localVarUrlObj),
options: localVarRequestOptions,
};
},
/**
* updates the topic with the new data.

@@ -459,11 +540,15 @@ * @summary Updates the topic with the specified name.

* @summary List of consumer groups in the Kafka instance.
* @param {number} [limit] Maximum number of consumer groups to returnd
* @param {number} [offset] The page offset when returning the list of consumer groups
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of consumer groups to return
* @param {number} [size] Maximum number of consumer groups to return on single page
* @param {number} [page] The page when returning the list of consumer groups
* @param {string} [topic] Return consumer groups for this topic
* @param {string} [groupIdFilter] Return the consumer groups where the ID begins with this value
* @param {'asc' | 'desc'} [order] Order of the consumer groups sorting. Ascending order is used as default.
* @param {'name'} [orderKey] Order key to sort the items by. Only the value \&#39;name\&#39; is currently applicable.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getConsumerGroups(limit?: number, offset?: number, topic?: string, groupIdFilter?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConsumerGroupList>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getConsumerGroups(limit, offset, topic, groupIdFilter, options);
async getConsumerGroups(offset?: number, limit?: number, size?: number, page?: number, topic?: string, groupIdFilter?: string, order?: 'asc' | 'desc', orderKey?: 'name', options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConsumerGroupList>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getConsumerGroups(offset, limit, size, page, topic, groupIdFilter, order, orderKey, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);

@@ -485,14 +570,29 @@ },

* @summary List of topics
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of topics to return
* @param {number} [size] Maximum number of topics to return on single page
* @param {string} [filter] Filter to apply when returning the list of topics
* @param {number} [offset] The page offset when returning the limit of requested topics.
* @param {string} [order] Order of the items sorting. If \&quot;asc\&quot; is set as a value, ascending order is used, descending otherwise.
* @param {number} [page] The page when returning the limit of requested topics.
* @param {'asc' | 'desc'} [order] Order of the items sorting. Ascending order is used as default.
* @param {'name' | 'partitions' | 'retention.ms' | 'retention.bytes'} [orderKey] Order key to sort the topics by.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async getTopics(limit?: number, filter?: string, offset?: number, order?: string, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TopicsList>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getTopics(limit, filter, offset, order, options);
async getTopics(offset?: number, limit?: number, size?: number, filter?: string, page?: number, order?: 'asc' | 'desc', orderKey?: 'name' | 'partitions' | 'retention.ms' | 'retention.bytes', options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TopicsList>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.getTopics(offset, limit, size, filter, page, order, orderKey, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
* Reset the offset for a particular consumer group.
* @summary Reset the offset for a consumer group.
* @param {string} consumerGroupId The ID of the consumer group.
* @param {ConsumerGroupResetOffsetParameters} consumerGroupResetOffsetParameters
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
async resetConsumerGroupOffset(consumerGroupId: string, consumerGroupResetOffsetParameters: ConsumerGroupResetOffsetParameters, options?: any): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<Array<object>>>> {
const localVarAxiosArgs = await localVarAxiosParamCreator.resetConsumerGroupOffset(consumerGroupId, consumerGroupResetOffsetParameters, options);
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
},
/**
* updates the topic with the new data.

@@ -563,11 +663,15 @@ * @summary Updates the topic with the specified name.

* @summary List of consumer groups in the Kafka instance.
* @param {number} [limit] Maximum number of consumer groups to returnd
* @param {number} [offset] The page offset when returning the list of consumer groups
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of consumer groups to return
* @param {number} [size] Maximum number of consumer groups to return on single page
* @param {number} [page] The page when returning the list of consumer groups
* @param {string} [topic] Return consumer groups for this topic
* @param {string} [groupIdFilter] Return the consumer groups where the ID begins with this value
* @param {'asc' | 'desc'} [order] Order of the consumer groups sorting. Ascending order is used as default.
* @param {'name'} [orderKey] Order key to sort the items by. Only the value \&#39;name\&#39; is currently applicable.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getConsumerGroups(limit?: number, offset?: number, topic?: string, groupIdFilter?: string, options?: any): AxiosPromise<ConsumerGroupList> {
return localVarFp.getConsumerGroups(limit, offset, topic, groupIdFilter, options).then((request) => request(axios, basePath));
getConsumerGroups(offset?: number, limit?: number, size?: number, page?: number, topic?: string, groupIdFilter?: string, order?: 'asc' | 'desc', orderKey?: 'name', options?: any): AxiosPromise<ConsumerGroupList> {
return localVarFp.getConsumerGroups(offset, limit, size, page, topic, groupIdFilter, order, orderKey, options).then((request) => request(axios, basePath));
},

@@ -587,13 +691,27 @@ /**

* @summary List of topics
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of topics to return
* @param {number} [size] Maximum number of topics to return on single page
* @param {string} [filter] Filter to apply when returning the list of topics
* @param {number} [offset] The page offset when returning the limit of requested topics.
* @param {string} [order] Order of the items sorting. If \&quot;asc\&quot; is set as a value, ascending order is used, descending otherwise.
* @param {number} [page] The page when returning the limit of requested topics.
* @param {'asc' | 'desc'} [order] Order of the items sorting. Ascending order is used as default.
* @param {'name' | 'partitions' | 'retention.ms' | 'retention.bytes'} [orderKey] Order key to sort the topics by.
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
getTopics(limit?: number, filter?: string, offset?: number, order?: string, options?: any): AxiosPromise<TopicsList> {
return localVarFp.getTopics(limit, filter, offset, order, options).then((request) => request(axios, basePath));
getTopics(offset?: number, limit?: number, size?: number, filter?: string, page?: number, order?: 'asc' | 'desc', orderKey?: 'name' | 'partitions' | 'retention.ms' | 'retention.bytes', options?: any): AxiosPromise<TopicsList> {
return localVarFp.getTopics(offset, limit, size, filter, page, order, orderKey, options).then((request) => request(axios, basePath));
},
/**
* Reset the offset for a particular consumer group.
* @summary Reset the offset for a consumer group.
* @param {string} consumerGroupId The ID of the consumer group.
* @param {ConsumerGroupResetOffsetParameters} consumerGroupResetOffsetParameters
* @param {*} [options] Override http request option.
* @throws {RequiredError}
*/
resetConsumerGroupOffset(consumerGroupId: string, consumerGroupResetOffsetParameters: ConsumerGroupResetOffsetParameters, options?: any): AxiosPromise<Array<Array<object>>> {
return localVarFp.resetConsumerGroupOffset(consumerGroupId, consumerGroupResetOffsetParameters, options).then((request) => request(axios, basePath));
},
/**
* updates the topic with the new data.

@@ -662,6 +780,10 @@ * @summary Updates the topic with the specified name.

* @summary List of consumer groups in the Kafka instance.
* @param {number} [limit] Maximum number of consumer groups to returnd
* @param {number} [offset] The page offset when returning the list of consumer groups
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of consumer groups to return
* @param {number} [size] Maximum number of consumer groups to return on single page
* @param {number} [page] The page when returning the list of consumer groups
* @param {string} [topic] Return consumer groups for this topic
* @param {string} [groupIdFilter] Return the consumer groups where the ID begins with this value
* @param {'asc' | 'desc'} [order] Order of the consumer groups sorting. Ascending order is used as default.
* @param {'name'} [orderKey] Order key to sort the items by. Only the value \&#39;name\&#39; is currently applicable.
* @param {*} [options] Override http request option.

@@ -671,3 +793,3 @@ * @throws {RequiredError}

*/
getConsumerGroups(limit?: number, offset?: number, topic?: string, groupIdFilter?: string, options?: any): AxiosPromise<ConsumerGroupList>;
getConsumerGroups(offset?: number, limit?: number, size?: number, page?: number, topic?: string, groupIdFilter?: string, order?: 'asc' | 'desc', orderKey?: 'name', options?: any): AxiosPromise<ConsumerGroupList>;

@@ -687,6 +809,9 @@ /**

* @summary List of topics
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of topics to return
* @param {number} [size] Maximum number of topics to return on single page
* @param {string} [filter] Filter to apply when returning the list of topics
* @param {number} [offset] The page offset when returning the limit of requested topics.
* @param {string} [order] Order of the items sorting. If \&quot;asc\&quot; is set as a value, ascending order is used, descending otherwise.
* @param {number} [page] The page when returning the limit of requested topics.
* @param {'asc' | 'desc'} [order] Order of the items sorting. Ascending order is used as default.
* @param {'name' | 'partitions' | 'retention.ms' | 'retention.bytes'} [orderKey] Order key to sort the topics by.
* @param {*} [options] Override http request option.

@@ -696,5 +821,16 @@ * @throws {RequiredError}

*/
getTopics(limit?: number, filter?: string, offset?: number, order?: string, options?: any): AxiosPromise<TopicsList>;
getTopics(offset?: number, limit?: number, size?: number, filter?: string, page?: number, order?: 'asc' | 'desc', orderKey?: 'name' | 'partitions' | 'retention.ms' | 'retention.bytes', options?: any): AxiosPromise<TopicsList>;
/**
* Reset the offset for a particular consumer group.
* @summary Reset the offset for a consumer group.
* @param {string} consumerGroupId The ID of the consumer group.
* @param {ConsumerGroupResetOffsetParameters} consumerGroupResetOffsetParameters
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DefaultApiInterface
*/
resetConsumerGroupOffset(consumerGroupId: string, consumerGroupResetOffsetParameters: ConsumerGroupResetOffsetParameters, options?: any): AxiosPromise<Array<Array<object>>>;
/**
* updates the topic with the new data.

@@ -771,6 +907,10 @@ * @summary Updates the topic with the specified name.

* @summary List of consumer groups in the Kafka instance.
* @param {number} [limit] Maximum number of consumer groups to returnd
* @param {number} [offset] The page offset when returning the list of consumer groups
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of consumer groups to return
* @param {number} [size] Maximum number of consumer groups to return on single page
* @param {number} [page] The page when returning the list of consumer groups
* @param {string} [topic] Return consumer groups for this topic
* @param {string} [groupIdFilter] Return the consumer groups where the ID begins with this value
* @param {'asc' | 'desc'} [order] Order of the consumer groups sorting. Ascending order is used as default.
* @param {'name'} [orderKey] Order key to sort the items by. Only the value \&#39;name\&#39; is currently applicable.
* @param {*} [options] Override http request option.

@@ -780,4 +920,4 @@ * @throws {RequiredError}

*/
public getConsumerGroups(limit?: number, offset?: number, topic?: string, groupIdFilter?: string, options?: any) {
return DefaultApiFp(this.configuration).getConsumerGroups(limit, offset, topic, groupIdFilter, options).then((request) => request(this.axios, this.basePath));
public getConsumerGroups(offset?: number, limit?: number, size?: number, page?: number, topic?: string, groupIdFilter?: string, order?: 'asc' | 'desc', orderKey?: 'name', options?: any) {
return DefaultApiFp(this.configuration).getConsumerGroups(offset, limit, size, page, topic, groupIdFilter, order, orderKey, options).then((request) => request(this.axios, this.basePath));
}

@@ -800,6 +940,9 @@

* @summary List of topics
* @param {number} [offset] The page offset
* @param {number} [limit] Maximum number of topics to return
* @param {number} [size] Maximum number of topics to return on single page
* @param {string} [filter] Filter to apply when returning the list of topics
* @param {number} [offset] The page offset when returning the limit of requested topics.
* @param {string} [order] Order of the items sorting. If \&quot;asc\&quot; is set as a value, ascending order is used, descending otherwise.
* @param {number} [page] The page when returning the limit of requested topics.
* @param {'asc' | 'desc'} [order] Order of the items sorting. Ascending order is used as default.
* @param {'name' | 'partitions' | 'retention.ms' | 'retention.bytes'} [orderKey] Order key to sort the topics by.
* @param {*} [options] Override http request option.

@@ -809,7 +952,20 @@ * @throws {RequiredError}

*/
public getTopics(limit?: number, filter?: string, offset?: number, order?: string, options?: any) {
return DefaultApiFp(this.configuration).getTopics(limit, filter, offset, order, options).then((request) => request(this.axios, this.basePath));
public getTopics(offset?: number, limit?: number, size?: number, filter?: string, page?: number, order?: 'asc' | 'desc', orderKey?: 'name' | 'partitions' | 'retention.ms' | 'retention.bytes', options?: any) {
return DefaultApiFp(this.configuration).getTopics(offset, limit, size, filter, page, order, orderKey, options).then((request) => request(this.axios, this.basePath));
}
/**
* Reset the offset for a particular consumer group.
* @summary Reset the offset for a consumer group.
* @param {string} consumerGroupId The ID of the consumer group.
* @param {ConsumerGroupResetOffsetParameters} consumerGroupResetOffsetParameters
* @param {*} [options] Override http request option.
* @throws {RequiredError}
* @memberof DefaultApi
*/
public resetConsumerGroupOffset(consumerGroupId: string, consumerGroupResetOffsetParameters: ConsumerGroupResetOffsetParameters, options?: any) {
return DefaultApiFp(this.configuration).resetConsumerGroupOffset(consumerGroupId, consumerGroupResetOffsetParameters, options).then((request) => request(this.axios, this.basePath));
}
/**
* updates the topic with the new data.

@@ -816,0 +972,0 @@ * @summary Updates the topic with the specified name.

@@ -29,3 +29,3 @@ /* tslint:disable */

*/
items: Array<ConsumerGroup>;
items?: Array<ConsumerGroup>;
/**

@@ -36,3 +36,3 @@ * The total number of consumer groups.

*/
count: number;
total?: number;
/**

@@ -43,11 +43,23 @@ * The number of consumer groups per page.

*/
limit: number;
size?: number;
/**
* The page offset
* The page
* @type {number}
* @memberof ConsumerGroupList
*/
offset: number;
page?: number;
/**
* Deprecated offset of the topic list
* @type {number}
* @memberof ConsumerGroupList
*/
offset?: number;
/**
* Deprecated maximum of returned topics
* @type {number}
* @memberof ConsumerGroupList
*/
limit?: number;
}

@@ -5,2 +5,3 @@ export * from './config-entry';

export * from './consumer-group-list';
export * from './consumer-group-reset-offset-parameters';
export * from './new-topic-input';

@@ -11,2 +12,3 @@ export * from './partition';

export * from './topics-list';
export * from './topics-to-reset-offset';
export * from './update-topic-input';

@@ -25,7 +25,7 @@ /* tslint:disable */

/**
* The page offset
* The page
* @type {number}
* @memberof TopicsList
*/
offset: number;
page?: number;
/**

@@ -36,4 +36,16 @@ * number of entries per page

*/
limit: number;
size?: number;
/**
* Deprecated offset of the topic list
* @type {number}
* @memberof TopicsList
*/
offset?: number;
/**
* Deprecated maximum of returned topics
* @type {number}
* @memberof TopicsList
*/
limit?: number;
/**
* Total number of topics

@@ -43,3 +55,3 @@ * @type {number}

*/
count: number;
total?: number;
/**

@@ -50,5 +62,5 @@ * List of topics

*/
items: Array<Topic>;
items?: Array<Topic>;
}

@@ -25,3 +25,3 @@ /* tslint:disable */

/**
* Topic configuration entry.
* Topic configuration entries.
* @type {Array<ConfigEntry>}

@@ -31,4 +31,10 @@ * @memberof UpdateTopicInput

config?: Array<ConfigEntry>;
/**
* Number of partitions (only increasing supported)
* @type {number}
* @memberof UpdateTopicInput
*/
partitions?: number;
}
SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc