Package com.oracle.bmc.datasafe.model

Class ReportDefinition

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public final class ReportDefinition
extends com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel
    Description of report definition.
    Note: Objects should always be created or deserialized using the ReportDefinition.Builder. This model distinguishes fields that are null because they are unset from fields that are explicitly set to null. This is done in the setter methods of the ReportDefinition.Builder, which maintain a set of all explicitly set fields called ReportDefinition.Builder.__explicitlySet__. The hashCode() and equals(Object) methods are implemented to take the explicitly set fields into account. The constructor, on the other hand, does not take the explicitly set fields into account (since the constructor cannot distinguish explicit null from unset null).

    • Method Detail

      • getDisplayName

        public String getDisplayName()
        Name of the report definition.
        Returns:
        the value

      • getId

        public String getId()
        The OCID of the report definition.
        Returns:
        the value

      • getParentId

        public String getParentId()
        The OCID of the parent report definition.

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

        Returns:
        the value

      • getCategory

        public ReportDefinition.Category getCategory()
        Specifies the name of the category that this report belongs to.
        Returns:
        the value

      • getDescription

        public String getDescription()
        A description of the report definition.
        Returns:
        the value

      • getDataSource

        public ReportDefinitionDataSource getDataSource()
        Specifies the name of a resource that provides data for the report.

        For example alerts, events.

        Returns:
        the value

      • getIsSeeded

        public Boolean getIsSeeded()
        Signifies whether the definition is seeded or user defined.

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

        Returns:
        the value

      • getDisplayOrder

        public Integer getDisplayOrder()
        Specifies how the report definitions are ordered in the display.
        Returns:
        the value

      • getTimeCreated

        public Date getTimeCreated()
        Specifies the date and time the report definition was created.
        Returns:
        the value

      • getTimeUpdated

        public Date getTimeUpdated()
        The date and time the report definition was updated.
        Returns:
        the value

      • getScimFilter

        public String getScimFilter()
        Additional SCIM filters used to define the report.
        Returns:
        the value

      • getColumnInfo

        public List<Column> getColumnInfo()
        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).

        Returns:
        the value

      • getColumnFilters

        public List<ColumnFilter> getColumnFilters()
        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.

        Returns:
        the value

      • getColumnSortings

        public List<ColumnSorting> getColumnSortings()
        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.

        Returns:
        the value

      • getSummary

        public List<Summary> getSummary()
        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).

        Returns:
        the value

      • getCompartmentId

        public String getCompartmentId()
        The OCID of the compartment containing the report definition.
        Returns:
        the value

      • getSchedule

        public String getSchedule()
        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

        Returns:
        the value

      • getScheduledReportRowLimit

        public Integer getScheduledReportRowLimit()
        Specifies the limit on the number of rows in the report.
        Returns:
        the value

      • getScheduledReportName

        public String getScheduledReportName()
        The name of the report to be scheduled.
        Returns:
        the value

      • getScheduledReportCompartmentId

        public String getScheduledReportCompartmentId()
        The OCID of the compartment in which the scheduled resource will be created.
        Returns:
        the value

      • getRecordTimeSpan

        public String getRecordTimeSpan()
        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)

        Returns:
        the value

      • getComplianceStandards

        public List<String> getComplianceStandards()
        The list of the data protection regulations/standards used in the report that will help demonstrate compliance.
        Returns:
        the value

      • getLifecycleDetails

        public String getLifecycleDetails()
        Details about the current state of the report definition in Data Safe.
        Returns:
        the value

      • getFreeformTags

        public Map<String,​String> getFreeformTags()
        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"}

        Returns:
        the value

      • getDefinedTags

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

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

        Returns:
        the value

      • getSystemTags

        public Map<String,​Map<String,​Object>> getSystemTags()
        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”}}

        Returns:
        the value

      • toString

        public String toString()
        Overrides:
        toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • toString

        public String toString​(boolean includeByteArrayContents)
        Return a string representation of the object.
        Parameters:
        includeByteArrayContents - true to include the full contents of byte arrays
        Returns:
        string representation

      • equals

        public boolean equals​(Object o)
        Overrides:
        equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel

      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModel