Oracle Cloud Infrastructure
getReportDefinition
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
using Pulumi;
using Oci = Pulumi.Oci;
class MyStack : Stack
{
public MyStack()
{
var testReportDefinition = Output.Create(Oci.DataSafe.GetReportDefinition.InvokeAsync(new Oci.DataSafe.GetReportDefinitionArgs
{
ReportDefinitionId = oci_data_safe_report_definition.Test_report_definition.Id,
}));
}
}
package main
import (
"github.com/pulumi/pulumi-oci/sdk/go/oci/DataSafe"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := DataSafe.GetReportDefinition(ctx, &datasafe.GetReportDefinitionArgs{
ReportDefinitionId: oci_data_safe_report_definition.Test_report_definition.Id,
}, nil)
if err != nil {
return err
}
return nil
})
}
Coming soon!
import pulumi
import pulumi_oci as oci
test_report_definition = oci.DataSafe.get_report_definition(report_definition_id=oci_data_safe_report_definition["test_report_definition"]["id"])
import * as pulumi from "@pulumi/pulumi";
import * as oci from "@pulumi/oci";
const testReportDefinition = oci.DataSafe.getReportDefinition({
reportDefinitionId: oci_data_safe_report_definition.test_report_definition.id,
});
Coming soon!
Using getReportDefinition
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getReportDefinition(args: GetReportDefinitionArgs, opts?: InvokeOptions): Promise<GetReportDefinitionResult>
function getReportDefinitionOutput(args: GetReportDefinitionOutputArgs, opts?: InvokeOptions): Output<GetReportDefinitionResult>
def get_report_definition(report_definition_id: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetReportDefinitionResult
def get_report_definition_output(report_definition_id: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetReportDefinitionResult]
func GetReportDefinition(ctx *Context, args *GetReportDefinitionArgs, opts ...InvokeOption) (*GetReportDefinitionResult, error)
func GetReportDefinitionOutput(ctx *Context, args *GetReportDefinitionOutputArgs, opts ...InvokeOption) GetReportDefinitionResultOutput
> Note: This function is named GetReportDefinition
in the Go SDK.
public static class GetReportDefinition
{
public static Task<GetReportDefinitionResult> InvokeAsync(GetReportDefinitionArgs args, InvokeOptions? opts = null)
public static Output<GetReportDefinitionResult> Invoke(GetReportDefinitionInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetReportDefinitionResult> getReportDefinition(GetReportDefinitionArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
Function: oci:DataSafe/getReportDefinition:getReportDefinition
Arguments:
# Arguments dictionary
The following arguments are supported:
- Report
Definition stringId Unique report definition identifier
- Report
Definition stringId Unique report definition identifier
- report
Definition StringId Unique report definition identifier
- report
Definition stringId Unique report definition identifier
- report_
definition_ strid Unique report definition identifier
- report
Definition StringId Unique report definition identifier
getReportDefinition Result
The following output properties are available:
- Category string
Specifies the name of the category that this report belongs to.
- Column
Filters List<GetReport Definition Column Filter> An array of column filter objects. A column Filter 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.
- Column
Infos List<GetReport Definition Column Info> 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).
- Column
Sortings List<GetReport Definition Column Sorting> 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.
- Compartment
Id string The OCID of the compartment containing the report definition.
- Data
Source string Specifies the name of a resource that provides data for the report. For example alerts, events.
- Dictionary<string, object>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- Description string
A description of the report definition.
- Display
Name string Name of the report definition.
- Display
Order int Specifies the order in which the summary must be displayed.
- Dictionary<string, object>
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 Example:
{"Department": "Finance"}
- Id string
The OCID of the report definition.
- Is
Seeded bool Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.
- Parent
Id string The OCID of the parent report definition. In the case of seeded report definition, this is same as definition OCID.
- Report
Definition stringId - Scim
Filter string Additional scim filters used to get the specific summary.
- State string
The current state of the report.
- Summaries
List<Get
Report Definition Summary> 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).
- Dictionary<string, object>
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"}
- Time
Created string Specifies the time at which the report definition was created.
- Time
Updated string The date and time of the report definition update in Data Safe.
- Category string
Specifies the name of the category that this report belongs to.
- Column
Filters []GetReport Definition Column Filter An array of column filter objects. A column Filter 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.
- Column
Infos []GetReport Definition Column Info 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).
- Column
Sortings []GetReport Definition Column Sorting 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.
- Compartment
Id string The OCID of the compartment containing the report definition.
- Data
Source string Specifies the name of a resource that provides data for the report. For example alerts, events.
- map[string]interface{}
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- Description string
A description of the report definition.
- Display
Name string Name of the report definition.
- Display
Order int Specifies the order in which the summary must be displayed.
- map[string]interface{}
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 Example:
{"Department": "Finance"}
- Id string
The OCID of the report definition.
- Is
Seeded bool Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.
- Parent
Id string The OCID of the parent report definition. In the case of seeded report definition, this is same as definition OCID.
- Report
Definition stringId - Scim
Filter string Additional scim filters used to get the specific summary.
- State string
The current state of the report.
- Summaries
[]Get
Report Definition Summary 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).
- map[string]interface{}
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"}
- Time
Created string Specifies the time at which the report definition was created.
- Time
Updated string The date and time of the report definition update in Data Safe.
- category String
Specifies the name of the category that this report belongs to.
- column
Filters List<GetReport Definition Column Filter> An array of column filter objects. A column Filter 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.
- column
Infos List<GetReport Definition Column Info> 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).
- column
Sortings List<GetReport Definition Column Sorting> 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.
- compartment
Id String The OCID of the compartment containing the report definition.
- data
Source String Specifies the name of a resource that provides data for the report. For example alerts, events.
- Map<String,Object>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description String
A description of the report definition.
- display
Name String Name of the report definition.
- display
Order Integer Specifies the order in which the summary must be displayed.
- Map<String,Object>
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 Example:
{"Department": "Finance"}
- id String
The OCID of the report definition.
- is
Seeded Boolean Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.
- parent
Id String The OCID of the parent report definition. In the case of seeded report definition, this is same as definition OCID.
- report
Definition StringId - scim
Filter String Additional scim filters used to get the specific summary.
- state String
The current state of the report.
- summaries
List<Get
Report Definition Summary> 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).
- Map<String,Object>
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"}
- time
Created String Specifies the time at which the report definition was created.
- time
Updated String The date and time of the report definition update in Data Safe.
- category string
Specifies the name of the category that this report belongs to.
- column
Filters GetReport Definition Column Filter[] An array of column filter objects. A column Filter 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.
- column
Infos GetReport Definition Column Info[] 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).
- column
Sortings GetReport Definition Column Sorting[] 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.
- compartment
Id string The OCID of the compartment containing the report definition.
- data
Source string Specifies the name of a resource that provides data for the report. For example alerts, events.
- {[key: string]: any}
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description string
A description of the report definition.
- display
Name string Name of the report definition.
- display
Order number Specifies the order in which the summary must be displayed.
- {[key: string]: any}
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 Example:
{"Department": "Finance"}
- id string
The OCID of the report definition.
- is
Seeded boolean Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.
- parent
Id string The OCID of the parent report definition. In the case of seeded report definition, this is same as definition OCID.
- report
Definition stringId - scim
Filter string Additional scim filters used to get the specific summary.
- state string
The current state of the report.
- summaries
Get
Report Definition Summary[] 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).
- {[key: string]: any}
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"}
- time
Created string Specifies the time at which the report definition was created.
- time
Updated string The date and time of the report definition update in Data Safe.
- category str
Specifies the name of the category that this report belongs to.
- column_
filters GetReport Definition Column Filter] An array of column filter objects. A column Filter 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.
- column_
infos GetReport Definition Column Info] 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).
- column_
sortings GetReport Definition Column Sorting] 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.
- compartment_
id str The OCID of the compartment containing the report definition.
- data_
source str Specifies the name of a resource that provides data for the report. For example alerts, events.
- Mapping[str, Any]
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description str
A description of the report definition.
- display_
name str Name of the report definition.
- display_
order int Specifies the order in which the summary must be displayed.
- Mapping[str, Any]
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 Example:
{"Department": "Finance"}
- id str
The OCID of the report definition.
- is_
seeded bool Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.
- parent_
id str The OCID of the parent report definition. In the case of seeded report definition, this is same as definition OCID.
- report_
definition_ strid - scim_
filter str Additional scim filters used to get the specific summary.
- state str
The current state of the report.
- summaries
Get
Report Definition Summary] 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).
- Mapping[str, Any]
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"}
- time_
created str Specifies the time at which the report definition was created.
- time_
updated str The date and time of the report definition update in Data Safe.
- category String
Specifies the name of the category that this report belongs to.
- column
Filters List<Property Map> An array of column filter objects. A column Filter 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.
- column
Infos List<Property Map> 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).
- column
Sortings List<Property Map> 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.
- compartment
Id String The OCID of the compartment containing the report definition.
- data
Source String Specifies the name of a resource that provides data for the report. For example alerts, events.
- Map<Any>
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example:
{"Operations.CostCenter": "42"}
- description String
A description of the report definition.
- display
Name String Name of the report definition.
- display
Order Number Specifies the order in which the summary must be displayed.
- Map<Any>
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 Example:
{"Department": "Finance"}
- id String
The OCID of the report definition.
- is
Seeded Boolean Signifies whether the definition is seeded or user defined. Values can either be 'true' or 'false'.
- parent
Id String The OCID of the parent report definition. In the case of seeded report definition, this is same as definition OCID.
- report
Definition StringId - scim
Filter String Additional scim filters used to get the specific summary.
- state String
The current state of the report.
- summaries List<Property Map>
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).
- Map<Any>
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"}
- time
Created String Specifies the time at which the report definition was created.
- time
Updated String The date and time of the report definition update in Data Safe.
Supporting Types
GetReportDefinitionColumnFilter
- Expressions List<string>
An array of expressions based on the operator type. A filter may have one or more expressions.
- Field
Name string Name of the column that must be sorted.
- Is
Enabled bool Indicates if the filter is enabled. Values can either be 'true' or 'false'.
- bool
Indicates if the summary is hidden. Values can either be 'true' or 'false'.
- Operator string
Specifies the type of operator that must be applied for example in, eq etc.
- Expressions []string
An array of expressions based on the operator type. A filter may have one or more expressions.
- Field
Name string Name of the column that must be sorted.
- Is
Enabled bool Indicates if the filter is enabled. Values can either be 'true' or 'false'.
- bool
Indicates if the summary is hidden. Values can either be 'true' or 'false'.
- Operator string
Specifies the type of operator that must be applied for example in, eq etc.
- expressions List<String>
An array of expressions based on the operator type. A filter may have one or more expressions.
- field
Name String Name of the column that must be sorted.
- is
Enabled Boolean Indicates if the filter is enabled. Values can either be 'true' or 'false'.
- Boolean
Indicates if the summary is hidden. Values can either be 'true' or 'false'.
- operator String
Specifies the type of operator that must be applied for example in, eq etc.
- expressions string[]
An array of expressions based on the operator type. A filter may have one or more expressions.
- field
Name string Name of the column that must be sorted.
- is
Enabled boolean Indicates if the filter is enabled. Values can either be 'true' or 'false'.
- boolean
Indicates if the summary is hidden. Values can either be 'true' or 'false'.
- operator string
Specifies the type of operator that must be applied for example in, eq etc.
- expressions Sequence[str]
An array of expressions based on the operator type. A filter may have one or more expressions.
- field_
name str Name of the column that must be sorted.
- is_
enabled bool Indicates if the filter is enabled. Values can either be 'true' or 'false'.
- bool
Indicates if the summary is hidden. Values can either be 'true' or 'false'.
- operator str
Specifies the type of operator that must be applied for example in, eq etc.
- expressions List<String>
An array of expressions based on the operator type. A filter may have one or more expressions.
- field
Name String Name of the column that must be sorted.
- is
Enabled Boolean Indicates if the filter is enabled. Values can either be 'true' or 'false'.
- Boolean
Indicates if the summary is hidden. Values can either be 'true' or 'false'.
- operator String
Specifies the type of operator that must be applied for example in, eq etc.
GetReportDefinitionColumnInfo
- Data
Type string Specifies the data type of the column.
- Display
Name string Name of the report definition.
- Display
Order int Specifies the order in which the summary must be displayed.
- Field
Name string Name of the column that must be sorted.
- bool
Indicates if the summary is hidden. Values can either be 'true' or 'false'.
- Data
Type string Specifies the data type of the column.
- Display
Name string Name of the report definition.
- Display
Order int Specifies the order in which the summary must be displayed.
- Field
Name string Name of the column that must be sorted.
- bool
Indicates if the summary is hidden. Values can either be 'true' or 'false'.
- data
Type String Specifies the data type of the column.
- display
Name String Name of the report definition.
- display
Order Integer Specifies the order in which the summary must be displayed.
- field
Name String Name of the column that must be sorted.
- Boolean
Indicates if the summary is hidden. Values can either be 'true' or 'false'.
- data
Type string Specifies the data type of the column.
- display
Name string Name of the report definition.
- display
Order number Specifies the order in which the summary must be displayed.
- field
Name string Name of the column that must be sorted.
- boolean
Indicates if the summary is hidden. Values can either be 'true' or 'false'.
- data_
type str Specifies the data type of the column.
- display_
name str Name of the report definition.
- display_
order int Specifies the order in which the summary must be displayed.
- field_
name str Name of the column that must be sorted.
- bool
Indicates if the summary is hidden. Values can either be 'true' or 'false'.
- data
Type String Specifies the data type of the column.
- display
Name String Name of the report definition.
- display
Order Number Specifies the order in which the summary must be displayed.
- field
Name String Name of the column that must be sorted.
- Boolean
Indicates if the summary is hidden. Values can either be 'true' or 'false'.
GetReportDefinitionColumnSorting
- Field
Name string Name of the column that must be sorted.
- Is
Ascending bool Indicates if the column must be sorted in ascending order. Values can either be 'true' or 'false'.
- Sorting
Order int Indicates the order at which column must be sorted.
- Field
Name string Name of the column that must be sorted.
- Is
Ascending bool Indicates if the column must be sorted in ascending order. Values can either be 'true' or 'false'.
- Sorting
Order int Indicates the order at which column must be sorted.
- field
Name String Name of the column that must be sorted.
- is
Ascending Boolean Indicates if the column must be sorted in ascending order. Values can either be 'true' or 'false'.
- sorting
Order Integer Indicates the order at which column must be sorted.
- field
Name string Name of the column that must be sorted.
- is
Ascending boolean Indicates if the column must be sorted in ascending order. Values can either be 'true' or 'false'.
- sorting
Order number Indicates the order at which column must be sorted.
- field_
name str Name of the column that must be sorted.
- is_
ascending bool Indicates if the column must be sorted in ascending order. Values can either be 'true' or 'false'.
- sorting_
order int Indicates the order at which column must be sorted.
- field
Name String Name of the column that must be sorted.
- is
Ascending Boolean Indicates if the column must be sorted in ascending order. Values can either be 'true' or 'false'.
- sorting
Order Number Indicates the order at which column must be sorted.
GetReportDefinitionSummary
- Count
Of string Name of the key or count of object.
- Display
Order int Specifies the order in which the summary must be displayed.
- Group
By stringField Name A comma-delimited string that specifies the names of the fields by which the records must be aggregated to get the summary.
- bool
Indicates if the summary is hidden. Values can either be 'true' or 'false'.
- Name string
Name of the report summary.
- Scim
Filter string Additional scim filters used to get the specific summary.
- Count
Of string Name of the key or count of object.
- Display
Order int Specifies the order in which the summary must be displayed.
- Group
By stringField Name A comma-delimited string that specifies the names of the fields by which the records must be aggregated to get the summary.
- bool
Indicates if the summary is hidden. Values can either be 'true' or 'false'.
- Name string
Name of the report summary.
- Scim
Filter string Additional scim filters used to get the specific summary.
- count
Of String Name of the key or count of object.
- display
Order Integer Specifies the order in which the summary must be displayed.
- group
By StringField Name A comma-delimited string that specifies the names of the fields by which the records must be aggregated to get the summary.
- Boolean
Indicates if the summary is hidden. Values can either be 'true' or 'false'.
- name String
Name of the report summary.
- scim
Filter String Additional scim filters used to get the specific summary.
- count
Of string Name of the key or count of object.
- display
Order number Specifies the order in which the summary must be displayed.
- group
By stringField Name A comma-delimited string that specifies the names of the fields by which the records must be aggregated to get the summary.
- boolean
Indicates if the summary is hidden. Values can either be 'true' or 'false'.
- name string
Name of the report summary.
- scim
Filter string Additional scim filters used to get the specific summary.
- count_
of str Name of the key or count of object.
- display_
order int Specifies the order in which the summary must be displayed.
- group_
by_ strfield_ name A comma-delimited string that specifies the names of the fields by which the records must be aggregated to get the summary.
- bool
Indicates if the summary is hidden. Values can either be 'true' or 'false'.
- name str
Name of the report summary.
- scim_
filter str Additional scim filters used to get the specific summary.
- count
Of String Name of the key or count of object.
- display
Order Number Specifies the order in which the summary must be displayed.
- group
By StringField Name A comma-delimited string that specifies the names of the fields by which the records must be aggregated to get the summary.
- Boolean
Indicates if the summary is hidden. Values can either be 'true' or 'false'.
- name String
Name of the report summary.
- scim
Filter String Additional scim filters used to get the specific summary.
Package Details
- Repository
- https://github.com/pulumi/pulumi-oci
- License
- Apache-2.0
- Notes
This Pulumi package is based on the
oci
Terraform Provider.