@herd/angular-client/dist/api/expectedPartitionValue.service.d.ts

Swagger generated client for @herd/angular-client

/**
 * herd
 * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
 *
 * OpenAPI spec version: 0.219.0-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 { HttpClient, HttpHeaders, HttpResponse, HttpEvent } from '@angular/common/http';
import { Observable } from 'rxjs';
import { ExpectedPartitionValueInformation } from '../model/expectedPartitionValueInformation';
import { ExpectedPartitionValuesCreateRequest } from '../model/expectedPartitionValuesCreateRequest';
import { ExpectedPartitionValuesDeleteRequest } from '../model/expectedPartitionValuesDeleteRequest';
import { ExpectedPartitionValuesInformation } from '../model/expectedPartitionValuesInformation';
import { Configuration } from '../configuration';
export declare class ExpectedPartitionValueService {
    protected httpClient: HttpClient;
    protected basePath: string;
    defaultHeaders: HttpHeaders;
    configuration: Configuration;
    constructor(httpClient: HttpClient, basePath: string, configuration: Configuration);
    /**
     * @param consumes string[] mime-types
     * @return true: consumes contains 'multipart/form-data', false: otherwise
     */
    private canConsumeForm;
    /**
     * createExpectedPartitionValues
     * Creates a list of expected partition values for an existing partition key group.
     * @param expectedPartitionValuesCreateRequest the information needed to create the expected partition values
     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
     * @param reportProgress flag to report request and response progress.
     */
    expectedPartitionValueCreateExpectedPartitionValues(expectedPartitionValuesCreateRequest: ExpectedPartitionValuesCreateRequest, observe?: 'body', reportProgress?: boolean): Observable<ExpectedPartitionValuesInformation>;
    expectedPartitionValueCreateExpectedPartitionValues(expectedPartitionValuesCreateRequest: ExpectedPartitionValuesCreateRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ExpectedPartitionValuesInformation>>;
    expectedPartitionValueCreateExpectedPartitionValues(expectedPartitionValuesCreateRequest: ExpectedPartitionValuesCreateRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ExpectedPartitionValuesInformation>>;
    /**
     * deleteExpectedPartitionValues
     * Deletes specified expected partition values from an existing partition key group which is identified by name.
     * @param expectedPartitionValuesDeleteRequest the information needed to delete the expected partition values
     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
     * @param reportProgress flag to report request and response progress.
     */
    expectedPartitionValueDeleteExpectedPartitionValues(expectedPartitionValuesDeleteRequest: ExpectedPartitionValuesDeleteRequest, observe?: 'body', reportProgress?: boolean): Observable<ExpectedPartitionValuesInformation>;
    expectedPartitionValueDeleteExpectedPartitionValues(expectedPartitionValuesDeleteRequest: ExpectedPartitionValuesDeleteRequest, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ExpectedPartitionValuesInformation>>;
    expectedPartitionValueDeleteExpectedPartitionValues(expectedPartitionValuesDeleteRequest: ExpectedPartitionValuesDeleteRequest, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ExpectedPartitionValuesInformation>>;
    /**
     * getExpectedPartitionValue
     * Retrieves an existing expected partition value plus/minus an optional offset.
     * @param partitionKeyGroupName the partition key group name
     * @param expectedPartitionValue the expected partition value to retrieve plus/minus an optional offset
     * @param offset the optional positive or negative offset
     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
     * @param reportProgress flag to report request and response progress.
     */
    expectedPartitionValueGetExpectedPartitionValue(partitionKeyGroupName: string, expectedPartitionValue: string, offset?: number, observe?: 'body', reportProgress?: boolean): Observable<ExpectedPartitionValueInformation>;
    expectedPartitionValueGetExpectedPartitionValue(partitionKeyGroupName: string, expectedPartitionValue: string, offset?: number, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ExpectedPartitionValueInformation>>;
    expectedPartitionValueGetExpectedPartitionValue(partitionKeyGroupName: string, expectedPartitionValue: string, offset?: number, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ExpectedPartitionValueInformation>>;
    /**
     * getExpectedPartitionValues
     * Retrieves a range of existing expected partition values.
     * @param partitionKeyGroupName the partition key group name
     * @param startExpectedPartitionValue the start expected partition value for the expected partition value range
     * @param endExpectedPartitionValue the end expected partition value for the expected partition value range
     * @param observe set whether or not to return the data Observable as the body, response or events. defaults to returning the body.
     * @param reportProgress flag to report request and response progress.
     */
    expectedPartitionValueGetExpectedPartitionValues(partitionKeyGroupName: string, startExpectedPartitionValue?: string, endExpectedPartitionValue?: string, observe?: 'body', reportProgress?: boolean): Observable<ExpectedPartitionValuesInformation>;
    expectedPartitionValueGetExpectedPartitionValues(partitionKeyGroupName: string, startExpectedPartitionValue?: string, endExpectedPartitionValue?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<ExpectedPartitionValuesInformation>>;
    expectedPartitionValueGetExpectedPartitionValues(partitionKeyGroupName: string, startExpectedPartitionValue?: string, endExpectedPartitionValue?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<ExpectedPartitionValuesInformation>>;
}