jack-kafka-instance-sdk/dist/generated/api/acls-api.d.ts

RHOAS Kafka Instance Adminstration SDK

/**
 * Kafka Instance API
 * API for interacting with Kafka Instance. Includes Produce, Consume and Admin APIs
 *
 * The version of the OpenAPI document: 0.14.1-SNAPSHOT
 *
 *
 * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
 * https://openapi-generator.tech
 * Do not edit the class manually.
 */
import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
import { Configuration } from '../configuration';
import { RequestArgs, BaseAPI } from '../base';
import { AclBinding } from '../model';
import { AclBindingListPage } from '../model';
import { AclBindingOrderKey } from '../model';
import { AclOperationFilter } from '../model';
import { AclPatternTypeFilter } from '../model';
import { AclPermissionTypeFilter } from '../model';
import { AclResourceTypeFilter } from '../model';
import { SortDirection } from '../model';
/**
 * AclsApi - axios parameter creator
 * @export
 */
export declare const AclsApiAxiosParamCreator: (configuration?: Configuration) => {
    /**
     * Creates a new ACL binding for a Kafka instance.
     * @summary Create ACL binding
     * @param {AclBinding} aclBinding ACL to create.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createAcl: (aclBinding: AclBinding, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Deletes ACL bindings that match the query parameters.
     * @summary Delete ACL bindings
     * @param {AclResourceTypeFilter} [resourceType] ACL Resource Type Filter
     * @param {string} [resourceName] ACL Resource Name Filter
     * @param {AclPatternTypeFilter} [patternType] ACL Pattern Type Filter
     * @param {string} [principal] ACL Principal Filter. Either a specific user or the wildcard user &#x60;User:*&#x60; may be provided. - When fetching by a specific user, the results will also include ACL bindings that apply to all users. - When deleting, ACL bindings to be delete must match the provided &#x60;principal&#x60; exactly.
     * @param {AclOperationFilter} [operation] ACL Operation Filter. The ACL binding operation provided should be valid for the resource type in the request, if not &#x60;ANY&#x60;.
     * @param {AclPermissionTypeFilter} [permission] ACL Permission Type Filter
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteAcls: (resourceType?: AclResourceTypeFilter, resourceName?: string, patternType?: AclPatternTypeFilter, principal?: string, operation?: AclOperationFilter, permission?: AclPermissionTypeFilter, options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Retrieve the resources and associated operations that may have ACLs configured.
     * @summary Retrieve allowed ACL resources and operations
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAclResourceOperations: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
    /**
     * Returns a list of all of the available ACL bindings, or the list of bindings that meet the user\'s URL query parameters. If no parameters are specified, all ACL bindings known to the system will be returned (with paging).
     * @summary List ACL bindings
     * @param {AclResourceTypeFilter} [resourceType] ACL Resource Type Filter
     * @param {string} [resourceName] ACL Resource Name Filter
     * @param {AclPatternTypeFilter} [patternType] ACL Pattern Type Filter
     * @param {string} [principal] ACL Principal Filter. Either a specific user or the wildcard user &#x60;User:*&#x60; may be provided. - When fetching by a specific user, the results will also include ACL bindings that apply to all users. - When deleting, ACL bindings to be delete must match the provided &#x60;principal&#x60; exactly.
     * @param {AclOperationFilter} [operation] ACL Operation Filter. The ACL binding operation provided should be valid for the resource type in the request, if not &#x60;ANY&#x60;.
     * @param {AclPermissionTypeFilter} [permission] ACL Permission Type Filter
     * @param {number} [page] Page number
     * @param {number} [size] Number of records per page
     * @param {SortDirection} [order] Order items are sorted
     * @param {AclBindingOrderKey} [orderKey]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAcls: (resourceType?: AclResourceTypeFilter, resourceName?: string, patternType?: AclPatternTypeFilter, principal?: string, operation?: AclOperationFilter, permission?: AclPermissionTypeFilter, page?: number, size?: number, order?: SortDirection, orderKey?: AclBindingOrderKey, options?: AxiosRequestConfig) => Promise<RequestArgs>;
};
/**
 * AclsApi - functional programming interface
 * @export
 */
export declare const AclsApiFp: (configuration?: Configuration) => {
    /**
     * Creates a new ACL binding for a Kafka instance.
     * @summary Create ACL binding
     * @param {AclBinding} aclBinding ACL to create.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createAcl(aclBinding: AclBinding, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
    /**
     * Deletes ACL bindings that match the query parameters.
     * @summary Delete ACL bindings
     * @param {AclResourceTypeFilter} [resourceType] ACL Resource Type Filter
     * @param {string} [resourceName] ACL Resource Name Filter
     * @param {AclPatternTypeFilter} [patternType] ACL Pattern Type Filter
     * @param {string} [principal] ACL Principal Filter. Either a specific user or the wildcard user &#x60;User:*&#x60; may be provided. - When fetching by a specific user, the results will also include ACL bindings that apply to all users. - When deleting, ACL bindings to be delete must match the provided &#x60;principal&#x60; exactly.
     * @param {AclOperationFilter} [operation] ACL Operation Filter. The ACL binding operation provided should be valid for the resource type in the request, if not &#x60;ANY&#x60;.
     * @param {AclPermissionTypeFilter} [permission] ACL Permission Type Filter
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteAcls(resourceType?: AclResourceTypeFilter, resourceName?: string, patternType?: AclPatternTypeFilter, principal?: string, operation?: AclOperationFilter, permission?: AclPermissionTypeFilter, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AclBindingListPage>>;
    /**
     * Retrieve the resources and associated operations that may have ACLs configured.
     * @summary Retrieve allowed ACL resources and operations
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAclResourceOperations(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<{
        [key: string]: string[];
    }>>;
    /**
     * Returns a list of all of the available ACL bindings, or the list of bindings that meet the user\'s URL query parameters. If no parameters are specified, all ACL bindings known to the system will be returned (with paging).
     * @summary List ACL bindings
     * @param {AclResourceTypeFilter} [resourceType] ACL Resource Type Filter
     * @param {string} [resourceName] ACL Resource Name Filter
     * @param {AclPatternTypeFilter} [patternType] ACL Pattern Type Filter
     * @param {string} [principal] ACL Principal Filter. Either a specific user or the wildcard user &#x60;User:*&#x60; may be provided. - When fetching by a specific user, the results will also include ACL bindings that apply to all users. - When deleting, ACL bindings to be delete must match the provided &#x60;principal&#x60; exactly.
     * @param {AclOperationFilter} [operation] ACL Operation Filter. The ACL binding operation provided should be valid for the resource type in the request, if not &#x60;ANY&#x60;.
     * @param {AclPermissionTypeFilter} [permission] ACL Permission Type Filter
     * @param {number} [page] Page number
     * @param {number} [size] Number of records per page
     * @param {SortDirection} [order] Order items are sorted
     * @param {AclBindingOrderKey} [orderKey]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAcls(resourceType?: AclResourceTypeFilter, resourceName?: string, patternType?: AclPatternTypeFilter, principal?: string, operation?: AclOperationFilter, permission?: AclPermissionTypeFilter, page?: number, size?: number, order?: SortDirection, orderKey?: AclBindingOrderKey, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<AclBindingListPage>>;
};
/**
 * AclsApi - factory interface
 * @export
 */
export declare const AclsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
    /**
     * Creates a new ACL binding for a Kafka instance.
     * @summary Create ACL binding
     * @param {AclBinding} aclBinding ACL to create.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    createAcl(aclBinding: AclBinding, options?: any): AxiosPromise<void>;
    /**
     * Deletes ACL bindings that match the query parameters.
     * @summary Delete ACL bindings
     * @param {AclResourceTypeFilter} [resourceType] ACL Resource Type Filter
     * @param {string} [resourceName] ACL Resource Name Filter
     * @param {AclPatternTypeFilter} [patternType] ACL Pattern Type Filter
     * @param {string} [principal] ACL Principal Filter. Either a specific user or the wildcard user &#x60;User:*&#x60; may be provided. - When fetching by a specific user, the results will also include ACL bindings that apply to all users. - When deleting, ACL bindings to be delete must match the provided &#x60;principal&#x60; exactly.
     * @param {AclOperationFilter} [operation] ACL Operation Filter. The ACL binding operation provided should be valid for the resource type in the request, if not &#x60;ANY&#x60;.
     * @param {AclPermissionTypeFilter} [permission] ACL Permission Type Filter
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    deleteAcls(resourceType?: AclResourceTypeFilter, resourceName?: string, patternType?: AclPatternTypeFilter, principal?: string, operation?: AclOperationFilter, permission?: AclPermissionTypeFilter, options?: any): AxiosPromise<AclBindingListPage>;
    /**
     * Retrieve the resources and associated operations that may have ACLs configured.
     * @summary Retrieve allowed ACL resources and operations
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAclResourceOperations(options?: any): AxiosPromise<{
        [key: string]: string[];
    }>;
    /**
     * Returns a list of all of the available ACL bindings, or the list of bindings that meet the user\'s URL query parameters. If no parameters are specified, all ACL bindings known to the system will be returned (with paging).
     * @summary List ACL bindings
     * @param {AclResourceTypeFilter} [resourceType] ACL Resource Type Filter
     * @param {string} [resourceName] ACL Resource Name Filter
     * @param {AclPatternTypeFilter} [patternType] ACL Pattern Type Filter
     * @param {string} [principal] ACL Principal Filter. Either a specific user or the wildcard user &#x60;User:*&#x60; may be provided. - When fetching by a specific user, the results will also include ACL bindings that apply to all users. - When deleting, ACL bindings to be delete must match the provided &#x60;principal&#x60; exactly.
     * @param {AclOperationFilter} [operation] ACL Operation Filter. The ACL binding operation provided should be valid for the resource type in the request, if not &#x60;ANY&#x60;.
     * @param {AclPermissionTypeFilter} [permission] ACL Permission Type Filter
     * @param {number} [page] Page number
     * @param {number} [size] Number of records per page
     * @param {SortDirection} [order] Order items are sorted
     * @param {AclBindingOrderKey} [orderKey]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     */
    getAcls(resourceType?: AclResourceTypeFilter, resourceName?: string, patternType?: AclPatternTypeFilter, principal?: string, operation?: AclOperationFilter, permission?: AclPermissionTypeFilter, page?: number, size?: number, order?: SortDirection, orderKey?: AclBindingOrderKey, options?: any): AxiosPromise<AclBindingListPage>;
};
/**
 * AclsApi - interface
 * @export
 * @interface AclsApi
 */
export interface AclsApiInterface {
    /**
     * Creates a new ACL binding for a Kafka instance.
     * @summary Create ACL binding
     * @param {AclBinding} aclBinding ACL to create.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AclsApiInterface
     */
    createAcl(aclBinding: AclBinding, options?: AxiosRequestConfig): AxiosPromise<void>;
    /**
     * Deletes ACL bindings that match the query parameters.
     * @summary Delete ACL bindings
     * @param {AclResourceTypeFilter} [resourceType] ACL Resource Type Filter
     * @param {string} [resourceName] ACL Resource Name Filter
     * @param {AclPatternTypeFilter} [patternType] ACL Pattern Type Filter
     * @param {string} [principal] ACL Principal Filter. Either a specific user or the wildcard user &#x60;User:*&#x60; may be provided. - When fetching by a specific user, the results will also include ACL bindings that apply to all users. - When deleting, ACL bindings to be delete must match the provided &#x60;principal&#x60; exactly.
     * @param {AclOperationFilter} [operation] ACL Operation Filter. The ACL binding operation provided should be valid for the resource type in the request, if not &#x60;ANY&#x60;.
     * @param {AclPermissionTypeFilter} [permission] ACL Permission Type Filter
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AclsApiInterface
     */
    deleteAcls(resourceType?: AclResourceTypeFilter, resourceName?: string, patternType?: AclPatternTypeFilter, principal?: string, operation?: AclOperationFilter, permission?: AclPermissionTypeFilter, options?: AxiosRequestConfig): AxiosPromise<AclBindingListPage>;
    /**
     * Retrieve the resources and associated operations that may have ACLs configured.
     * @summary Retrieve allowed ACL resources and operations
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AclsApiInterface
     */
    getAclResourceOperations(options?: AxiosRequestConfig): AxiosPromise<{
        [key: string]: Array<string>;
    }>;
    /**
     * Returns a list of all of the available ACL bindings, or the list of bindings that meet the user\'s URL query parameters. If no parameters are specified, all ACL bindings known to the system will be returned (with paging).
     * @summary List ACL bindings
     * @param {AclResourceTypeFilter} [resourceType] ACL Resource Type Filter
     * @param {string} [resourceName] ACL Resource Name Filter
     * @param {AclPatternTypeFilter} [patternType] ACL Pattern Type Filter
     * @param {string} [principal] ACL Principal Filter. Either a specific user or the wildcard user &#x60;User:*&#x60; may be provided. - When fetching by a specific user, the results will also include ACL bindings that apply to all users. - When deleting, ACL bindings to be delete must match the provided &#x60;principal&#x60; exactly.
     * @param {AclOperationFilter} [operation] ACL Operation Filter. The ACL binding operation provided should be valid for the resource type in the request, if not &#x60;ANY&#x60;.
     * @param {AclPermissionTypeFilter} [permission] ACL Permission Type Filter
     * @param {number} [page] Page number
     * @param {number} [size] Number of records per page
     * @param {SortDirection} [order] Order items are sorted
     * @param {AclBindingOrderKey} [orderKey]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AclsApiInterface
     */
    getAcls(resourceType?: AclResourceTypeFilter, resourceName?: string, patternType?: AclPatternTypeFilter, principal?: string, operation?: AclOperationFilter, permission?: AclPermissionTypeFilter, page?: number, size?: number, order?: SortDirection, orderKey?: AclBindingOrderKey, options?: AxiosRequestConfig): AxiosPromise<AclBindingListPage>;
}
/**
 * AclsApi - object-oriented interface
 * @export
 * @class AclsApi
 * @extends {BaseAPI}
 */
export declare class AclsApi extends BaseAPI implements AclsApiInterface {
    /**
     * Creates a new ACL binding for a Kafka instance.
     * @summary Create ACL binding
     * @param {AclBinding} aclBinding ACL to create.
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AclsApi
     */
    createAcl(aclBinding: AclBinding, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
    /**
     * Deletes ACL bindings that match the query parameters.
     * @summary Delete ACL bindings
     * @param {AclResourceTypeFilter} [resourceType] ACL Resource Type Filter
     * @param {string} [resourceName] ACL Resource Name Filter
     * @param {AclPatternTypeFilter} [patternType] ACL Pattern Type Filter
     * @param {string} [principal] ACL Principal Filter. Either a specific user or the wildcard user &#x60;User:*&#x60; may be provided. - When fetching by a specific user, the results will also include ACL bindings that apply to all users. - When deleting, ACL bindings to be delete must match the provided &#x60;principal&#x60; exactly.
     * @param {AclOperationFilter} [operation] ACL Operation Filter. The ACL binding operation provided should be valid for the resource type in the request, if not &#x60;ANY&#x60;.
     * @param {AclPermissionTypeFilter} [permission] ACL Permission Type Filter
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AclsApi
     */
    deleteAcls(resourceType?: AclResourceTypeFilter, resourceName?: string, patternType?: AclPatternTypeFilter, principal?: string, operation?: AclOperationFilter, permission?: AclPermissionTypeFilter, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AclBindingListPage, any>>;
    /**
     * Retrieve the resources and associated operations that may have ACLs configured.
     * @summary Retrieve allowed ACL resources and operations
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AclsApi
     */
    getAclResourceOperations(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<{
        [key: string]: string[];
    }, any>>;
    /**
     * Returns a list of all of the available ACL bindings, or the list of bindings that meet the user\'s URL query parameters. If no parameters are specified, all ACL bindings known to the system will be returned (with paging).
     * @summary List ACL bindings
     * @param {AclResourceTypeFilter} [resourceType] ACL Resource Type Filter
     * @param {string} [resourceName] ACL Resource Name Filter
     * @param {AclPatternTypeFilter} [patternType] ACL Pattern Type Filter
     * @param {string} [principal] ACL Principal Filter. Either a specific user or the wildcard user &#x60;User:*&#x60; may be provided. - When fetching by a specific user, the results will also include ACL bindings that apply to all users. - When deleting, ACL bindings to be delete must match the provided &#x60;principal&#x60; exactly.
     * @param {AclOperationFilter} [operation] ACL Operation Filter. The ACL binding operation provided should be valid for the resource type in the request, if not &#x60;ANY&#x60;.
     * @param {AclPermissionTypeFilter} [permission] ACL Permission Type Filter
     * @param {number} [page] Page number
     * @param {number} [size] Number of records per page
     * @param {SortDirection} [order] Order items are sorted
     * @param {AclBindingOrderKey} [orderKey]
     * @param {*} [options] Override http request option.
     * @throws {RequiredError}
     * @memberof AclsApi
     */
    getAcls(resourceType?: AclResourceTypeFilter, resourceName?: string, patternType?: AclPatternTypeFilter, principal?: string, operation?: AclOperationFilter, permission?: AclPermissionTypeFilter, page?: number, size?: number, order?: SortDirection, orderKey?: AclBindingOrderKey, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<AclBindingListPage, any>>;
}