Interface ReportObjectClient

Interface consumed by insight helpers that read report objects.

interface ReportObjectClient {
    downloadReportObjectText(
        bucketName: string,
        key: string,
        options?: DownloadReportObjectTextOptions,
    ): Promise<ReportObjectText>;
    listReportObjectKeys(
        bucketName: string,
        options?: ListReportObjectKeysOptions,
    ): Promise<ReportObjectPage>;
}

Implemented by

B2ReportClient

Index

Methods

downloadReportObjectText listReportObjectKeys

Methods

downloadReportObjectText

downloadReportObjectText(
    bucketName: string,
    key: string,
    options?: DownloadReportObjectTextOptions,
): Promise<ReportObjectText>
Download report object text with byte and time bounds.
Parameters
- bucketName: string
- key: string
- Optionaloptions: DownloadReportObjectTextOptions
Returns Promise<ReportObjectText>
- Defined in b2/report-client.ts:74

listReportObjectKeys

listReportObjectKeys(
bucketName: string,
options?: ListReportObjectKeysOptions,
): Promise<ReportObjectPage>
List report object keys from a reports bucket.
Parameters
- bucketName: string
- Optionaloptions: ListReportObjectKeysOptions
Returns Promise<ReportObjectPage>
- Defined in b2/report-client.ts:69