@herd/angular-client/dist/api/storageUnit.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 { StorageUnitDownloadCredential } from '../model/storageUnitDownloadCredential';
import { StorageUnitUploadCredential } from '../model/storageUnitUploadCredential';
import { Configuration } from '../configuration';
export declare class StorageUnitService {
    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;
    /**
     * getStorageUnitDownloadCredential
     * Gets the AWS credential to download to the specified storage unit. <p>Requires READ permission on namespace</p>
     * @param namespace the namespace
     * @param businessObjectDefinitionName the business object definition name
     * @param businessObjectFormatUsage the business object format usage
     * @param businessObjectFormatFileType the business object format file type
     * @param businessObjectFormatVersion the business object format version
     * @param partitionValue the partition value
     * @param businessObjectDataVersion the business object data version
     * @param storageName the storage name
     * @param subPartitionValues the sub-partition values
     * @param allowedSourceIpAddresses the list of allowed source IP addresses or subnets
     * @param allowedSourceVpcEndpoints the list of allowed source VPC endpoints
     * @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.
     */
    storageUnitGetStorageUnitDownloadCredential(namespace: string, businessObjectDefinitionName: string, businessObjectFormatUsage: string, businessObjectFormatFileType: string, businessObjectFormatVersion: number, partitionValue: string, businessObjectDataVersion: number, storageName: string, subPartitionValues?: string, allowedSourceIpAddresses?: string, allowedSourceVpcEndpoints?: string, observe?: 'body', reportProgress?: boolean): Observable<StorageUnitDownloadCredential>;
    storageUnitGetStorageUnitDownloadCredential(namespace: string, businessObjectDefinitionName: string, businessObjectFormatUsage: string, businessObjectFormatFileType: string, businessObjectFormatVersion: number, partitionValue: string, businessObjectDataVersion: number, storageName: string, subPartitionValues?: string, allowedSourceIpAddresses?: string, allowedSourceVpcEndpoints?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<StorageUnitDownloadCredential>>;
    storageUnitGetStorageUnitDownloadCredential(namespace: string, businessObjectDefinitionName: string, businessObjectFormatUsage: string, businessObjectFormatFileType: string, businessObjectFormatVersion: number, partitionValue: string, businessObjectDataVersion: number, storageName: string, subPartitionValues?: string, allowedSourceIpAddresses?: string, allowedSourceVpcEndpoints?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<StorageUnitDownloadCredential>>;
    /**
     * getStorageUnitUploadCredential
     * Gets the AWS credential to upload to the specified storage unit. &lt;p&gt;Requires WRITE permission on namespace&lt;/p&gt;
     * @param namespace the namespace
     * @param businessObjectDefinitionName the business object definition name
     * @param businessObjectFormatUsage the business object format usage
     * @param businessObjectFormatFileType the business object format file type
     * @param businessObjectFormatVersion the business object format version
     * @param partitionValue the partition value
     * @param businessObjectDataVersion the business object data version
     * @param storageName the storage name
     * @param subPartitionValues the sub-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.
     */
    storageUnitGetStorageUnitUploadCredential(namespace: string, businessObjectDefinitionName: string, businessObjectFormatUsage: string, businessObjectFormatFileType: string, businessObjectFormatVersion: number, partitionValue: string, businessObjectDataVersion: number, storageName: string, subPartitionValues?: string, observe?: 'body', reportProgress?: boolean): Observable<StorageUnitUploadCredential>;
    storageUnitGetStorageUnitUploadCredential(namespace: string, businessObjectDefinitionName: string, businessObjectFormatUsage: string, businessObjectFormatFileType: string, businessObjectFormatVersion: number, partitionValue: string, businessObjectDataVersion: number, storageName: string, subPartitionValues?: string, observe?: 'response', reportProgress?: boolean): Observable<HttpResponse<StorageUnitUploadCredential>>;
    storageUnitGetStorageUnitUploadCredential(namespace: string, businessObjectDefinitionName: string, businessObjectFormatUsage: string, businessObjectFormatFileType: string, businessObjectFormatVersion: number, partitionValue: string, businessObjectDataVersion: number, storageName: string, subPartitionValues?: string, observe?: 'events', reportProgress?: boolean): Observable<HttpEvent<StorageUnitUploadCredential>>;
}