Package com.oracle.bmc.datasafe.model

Class ReportDefinition.Builder

    • Constructor Detail

      • Builder

        public Builder()

    • Method Detail

      • displayName

        public ReportDefinition.Builder displayName​(String displayName)
        Name of the report definition.
        Parameters:
        displayName - the value to set
        Returns:
        this builder

      • parentId

        public ReportDefinition.Builder parentId​(String parentId)
        The OCID of the parent report definition.

        In the case of seeded report definition, this is same as definition OCID.

        Parameters:
        parentId - the value to set
        Returns:
        this builder

      • description

        public ReportDefinition.Builder description​(String description)
        A description of the report definition.
        Parameters:
        description - the value to set
        Returns:
        this builder

      • dataSource

        public ReportDefinition.Builder dataSource​(ReportDefinitionDataSource dataSource)
        Specifies the name of a resource that provides data for the report.

        For example alerts, events.

        Parameters:
        dataSource - the value to set
        Returns:
        this builder

      • isSeeded

        public ReportDefinition.Builder isSeeded​(Boolean isSeeded)
        Signifies whether the definition is seeded or user defined.

        Values can either be ‘true’ or ‘false’.

        Parameters:
        isSeeded - the value to set
        Returns:
        this builder

      • displayOrder

        public ReportDefinition.Builder displayOrder​(Integer displayOrder)
        Specifies how the report definitions are ordered in the display.
        Parameters:
        displayOrder - the value to set
        Returns:
        this builder

      • timeCreated

        public ReportDefinition.Builder timeCreated​(Date timeCreated)
        Specifies the date and time the report definition was created.
        Parameters:
        timeCreated - the value to set
        Returns:
        this builder

      • timeUpdated

        public ReportDefinition.Builder timeUpdated​(Date timeUpdated)
        The date and time the report definition was updated.
        Parameters:
        timeUpdated - the value to set
        Returns:
        this builder

      • scimFilter

        public ReportDefinition.Builder scimFilter​(String scimFilter)
        Additional SCIM filters used to define the report.
        Parameters:
        scimFilter - the value to set
        Returns:
        this builder

      • columnInfo

        public ReportDefinition.Builder columnInfo​(List<Column> columnInfo)
        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).

        Parameters:
        columnInfo - the value to set
        Returns:
        this builder

      • columnFilters

        public ReportDefinition.Builder columnFilters​(List<ColumnFilter> columnFilters)
        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.

        Parameters:
        columnFilters - the value to set
        Returns:
        this builder

      • columnSortings

        public ReportDefinition.Builder columnSortings​(List<ColumnSorting> columnSortings)
        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.

        Parameters:
        columnSortings - the value to set
        Returns:
        this builder

      • summary

        public ReportDefinition.Builder summary​(List<Summary> 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).

        Parameters:
        summary - the value to set
        Returns:
        this builder

      • compartmentId

        public ReportDefinition.Builder compartmentId​(String compartmentId)
        The OCID of the compartment containing the report definition.
        Parameters:
        compartmentId - the value to set
        Returns:
        this builder

      • schedule

        public ReportDefinition.Builder schedule​(String schedule)
        The schedule to generate the report periodically in the specified format: ;

        Allowed version strings - "v1" v1's version specific schedule - Each of the above fields potentially introduce constraints. A workrequest is created only when clock time satisfies all the constraints. Constraints introduced: 1. seconds = (So, the allowed range for is [0, 59]) 2. minutes = (So, the allowed range for is [0, 59]) 3. hours = (So, the allowed range for is [0, 23]) 4. can be either '*' (without quotes or a number between 1(Monday) and 7(Sunday)) No constraint introduced when it is '*'. When not, day of week must equal the given value 5. can be either '*' (without quotes or a number between 1 and 28) No constraint introduced when it is '*'. When not, day of month must equal the given value

        Parameters:
        schedule - the value to set
        Returns:
        this builder

      • scheduledReportRowLimit

        public ReportDefinition.Builder scheduledReportRowLimit​(Integer scheduledReportRowLimit)
        Specifies the limit on the number of rows in the report.
        Parameters:
        scheduledReportRowLimit - the value to set
        Returns:
        this builder

      • scheduledReportName

        public ReportDefinition.Builder scheduledReportName​(String scheduledReportName)
        The name of the report to be scheduled.
        Parameters:
        scheduledReportName - the value to set
        Returns:
        this builder

      • scheduledReportCompartmentId

        public ReportDefinition.Builder scheduledReportCompartmentId​(String scheduledReportCompartmentId)
        The OCID of the compartment in which the scheduled resource will be created.
        Parameters:
        scheduledReportCompartmentId - the value to set
        Returns:
        this builder

      • recordTimeSpan

        public ReportDefinition.Builder recordTimeSpan​(String recordTimeSpan)
        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)

        Parameters:
        recordTimeSpan - the value to set
        Returns:
        this builder

      • complianceStandards

        public ReportDefinition.Builder complianceStandards​(List<String> complianceStandards)
        The list of the data protection regulations/standards used in the report that will help demonstrate compliance.
        Parameters:
        complianceStandards - the value to set
        Returns:
        this builder

      • lifecycleDetails

        public ReportDefinition.Builder lifecycleDetails​(String lifecycleDetails)
        Details about the current state of the report definition in Data Safe.
        Parameters:
        lifecycleDetails - the value to set
        Returns:
        this builder

      • freeformTags

        public ReportDefinition.Builder freeformTags​(Map<String,​String> freeformTags)
        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"}

        Parameters:
        freeformTags - the value to set
        Returns:
        this builder

      • definedTags

        public ReportDefinition.Builder definedTags​(Map<String,​Map<String,​Object>> definedTags)
        Defined tags for this resource.

        Each key is predefined and scoped to a namespace. For more information, see Resource Tags Example: {“Operations”: {“CostCenter”: “42”}}

        Parameters:
        definedTags - the value to set
        Returns:
        this builder

      • systemTags

        public ReportDefinition.Builder systemTags​(Map<String,​Map<String,​Object>> systemTags)
        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”}}

        Parameters:
        systemTags - the value to set
        Returns:
        this builder