import * as pulumi from "@pulumi/pulumi"; import * as outputs from "../types/output"; /** * This data source provides details about a specific Report Definition resource in Oracle Cloud Infrastructure Data Safe service. * * Gets the details of report definition specified by the identifier * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testReportDefinition = oci.datasafe.getReportDefinition({ * reportDefinitionId: testReportDefinitionOciDataSafeReportDefinition.id, * }); * ``` */ export declare function getReportDefinition(args: GetReportDefinitionArgs, opts?: pulumi.InvokeOptions): Promise; /** * A collection of arguments for invoking getReportDefinition. */ export interface GetReportDefinitionArgs { /** * Unique report definition identifier */ reportDefinitionId: string; } /** * A collection of values returned by getReportDefinition. */ export interface GetReportDefinitionResult { /** * Specifies the name of the category that this report belongs to. */ readonly category: string; /** * An array of columnFilter objects. A columnFilter object stores all information about a column filter including field name, an operator, one or more expressions, if the filter is enabled, or if the filter is hidden. */ readonly columnFilters: outputs.DataSafe.GetReportDefinitionColumnFilter[]; /** * An array of column objects in the order (left to right) displayed in the report. A column object stores all information about a column, including the name displayed on the UI, corresponding field name in the data source, data type of the column, and column visibility (if the column is visible to the user). */ readonly columnInfos: outputs.DataSafe.GetReportDefinitionColumnInfo[]; /** * An array of column sorting objects. Each column sorting object stores the column name to be sorted and if the sorting is in ascending order; sorting is done by the first column in the array, then by the second column in the array, etc. */ readonly columnSortings: outputs.DataSafe.GetReportDefinitionColumnSorting[]; /** * The OCID of the compartment containing the report definition. */ readonly compartmentId: string; /** * The list of the data protection regulations/standards used in the report that will help demonstrate compliance. */ readonly complianceStandards: string[]; /** * Specifies the name of a resource that provides data for the report. For example alerts, events. */ readonly dataSource: string; /** * Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Operations.CostCenter": "42"}` */ readonly definedTags: { [key: string]: string; }; /** * A description of the report definition. */ readonly description: string; /** * Name of the report definition. */ readonly displayName: string; /** * Specifies the order in which the summary must be displayed. */ readonly displayOrder: number; /** * Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see [Resource Tags](https://docs.cloud.oracle.com/iaas/Content/General/Concepts/resourcetags.htm) Example: `{"Department": "Finance"}` */ readonly freeformTags: { [key: string]: string; }; /** * The OCID of the report definition. */ readonly id: string; /** * Indicates if the reports being generated should be paginated. If set to true, multiple reports can be generated and the details of next and previous report are present in Report. Values can either be 'true' or 'false'. */ readonly isSchedulePaginationEnabled: boolean; /** * Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'. */ readonly isSeeded: boolean; /** * Details about the current state of the report definition in Data Safe. */ readonly lifecycleDetails: string; /** * The OCID of the parent report definition. In the case of seeded report definition, this is same as definition OCID. */ readonly parentId: string; /** * The time span for the records in the report to be scheduled. Allowed period strings - "H","D","M","Y" Each of the above fields potentially introduce constraints. A workRequest is created only when period-value satisfies all the constraints. Constraints introduced: 1. period = H (The allowed range for period-value is [1, 23]) 2. period = D (The allowed range for period-value is [1, 30]) 3. period = M (The allowed range for period-value is [1, 11]) 4. period = Y (The minimum period-value is 1) */ readonly recordTimeSpan: string; readonly reportDefinitionId: string; /** * The schedule to generate the report periodically in the specified format: ; */ readonly schedule: string; /** * The OCID of the compartment in which the scheduled resource will be created. */ readonly scheduledReportCompartmentId: string; /** * Specifies the format of the report ( either .xls or .pdf or .json) */ readonly scheduledReportMimeType: string; /** * The name of the report to be scheduled. */ readonly scheduledReportName: string; /** * Specifies the limit on the number of rows in the report. */ readonly scheduledReportRowLimit: number; /** * Additional scim filters used to get the specific summary. */ readonly scimFilter: string; /** * The current state of the report. */ readonly state: string; /** * An array of report summary objects in the order (left to right) displayed in the report. A report summary object stores all information about summary of report to be displayed, including the name displayed on UI, the display order, corresponding group by and count of values, summary visibility (if the summary is visible to user). */ readonly summaries: outputs.DataSafe.GetReportDefinitionSummary[]; /** * System tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags. Example: `{"orcl-cloud.free-tier-retained": "true"}` */ readonly systemTags: { [key: string]: string; }; /** * Specifies the date and time the report definition was created. */ readonly timeCreated: string; /** * The date and time the report definition was updated. */ readonly timeUpdated: string; } /** * This data source provides details about a specific Report Definition resource in Oracle Cloud Infrastructure Data Safe service. * * Gets the details of report definition specified by the identifier * * ## Example Usage * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as oci from "@pulumi/oci"; * * const testReportDefinition = oci.datasafe.getReportDefinition({ * reportDefinitionId: testReportDefinitionOciDataSafeReportDefinition.id, * }); * ``` */ export declare function getReportDefinitionOutput(args: GetReportDefinitionOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output; /** * A collection of arguments for invoking getReportDefinition. */ export interface GetReportDefinitionOutputArgs { /** * Unique report definition identifier */ reportDefinitionId: pulumi.Input; } //# sourceMappingURL=getReportDefinition.d.ts.map