@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).
| Modifier and Type | Class and Description |
|---|---|
static class |
ReportDefinition.Builder |
static class |
ReportDefinition.Category
Specifies the name of the category that this report belongs to.
|
static class |
ReportDefinition.ScheduledReportMimeType
Specifies the format of the report ( either .xls or .pdf or .json)
|
EXPLICITLY_SET_FILTER_NAME, EXPLICITLY_SET_PROPERTY_NAME| Constructor and Description |
|---|
ReportDefinition(String displayName,
String id,
String parentId,
ReportDefinition.Category category,
String description,
ReportDefinitionDataSource dataSource,
Boolean isSeeded,
Integer displayOrder,
Date timeCreated,
Date timeUpdated,
String scimFilter,
List<Column> columnInfo,
List<ColumnFilter> columnFilters,
List<ColumnSorting> columnSortings,
List<Summary> summary,
String compartmentId,
ReportDefinitionLifecycleState lifecycleState,
String schedule,
ReportDefinition.ScheduledReportMimeType scheduledReportMimeType,
Integer scheduledReportRowLimit,
String scheduledReportName,
String scheduledReportCompartmentId,
String recordTimeSpan,
List<String> complianceStandards,
String lifecycleDetails,
Map<String,String> freeformTags,
Map<String,Map<String,Object>> definedTags,
Map<String,Map<String,Object>> systemTags)
Deprecated.
|
| Modifier and Type | Method and Description |
|---|---|
static ReportDefinition.Builder |
builder()
Create a new builder.
|
boolean |
equals(Object o) |
ReportDefinition.Category |
getCategory()
Specifies the name of the category that this report belongs to.
|
List<ColumnFilter> |
getColumnFilters()
An array of columnFilter objects.
|
List<Column> |
getColumnInfo()
An array of column objects in the order (left to right) displayed in the report.
|
List<ColumnSorting> |
getColumnSortings()
An array of column sorting objects.
|
String |
getCompartmentId()
The OCID of the compartment containing the report definition.
|
List<String> |
getComplianceStandards()
The list of the data protection regulations/standards used in the report that will help
demonstrate compliance.
|
ReportDefinitionDataSource |
getDataSource()
Specifies the name of a resource that provides data for the report.
|
Map<String,Map<String,Object>> |
getDefinedTags()
Defined tags for this resource.
|
String |
getDescription()
A description of the report definition.
|
String |
getDisplayName()
Name of the report definition.
|
Integer |
getDisplayOrder()
Specifies how the report definitions are ordered in the display.
|
Map<String,String> |
getFreeformTags()
Free-form tags for this resource.
|
String |
getId()
The OCID of the report definition.
|
Boolean |
getIsSeeded()
Signifies whether the definition is seeded or user defined.
|
String |
getLifecycleDetails()
Details about the current state of the report definition in Data Safe.
|
ReportDefinitionLifecycleState |
getLifecycleState()
The current state of the report.
|
String |
getParentId()
The OCID of the parent report definition.
|
String |
getRecordTimeSpan()
The time span for the records in the report to be scheduled.
|
String |
getSchedule()
The schedule to generate the report periodically in the specified format:
|
String |
getScheduledReportCompartmentId()
The OCID of the compartment in which the scheduled resource will be created.
|
ReportDefinition.ScheduledReportMimeType |
getScheduledReportMimeType()
Specifies the format of the report ( either .xls or .pdf or .json)
|
String |
getScheduledReportName()
The name of the report to be scheduled.
|
Integer |
getScheduledReportRowLimit()
Specifies the limit on the number of rows in the report.
|
String |
getScimFilter()
Additional SCIM filters used to define the report.
|
List<Summary> |
getSummary()
An array of report summary objects in the order (left to right) displayed in the report.
|
Map<String,Map<String,Object>> |
getSystemTags()
System tags for this resource.
|
Date |
getTimeCreated()
Specifies the date and time the report definition was created.
|
Date |
getTimeUpdated()
The date and time the report definition was updated.
|
int |
hashCode() |
ReportDefinition.Builder |
toBuilder() |
String |
toString() |
String |
toString(boolean includeByteArrayContents)
Return a string representation of the object.
|
markPropertyAsExplicitlySet, wasPropertyExplicitlySet@Deprecated @ConstructorProperties(value={"displayName","id","parentId","category","description","dataSource","isSeeded","displayOrder","timeCreated","timeUpdated","scimFilter","columnInfo","columnFilters","columnSortings","summary","compartmentId","lifecycleState","schedule","scheduledReportMimeType","scheduledReportRowLimit","scheduledReportName","scheduledReportCompartmentId","recordTimeSpan","complianceStandards","lifecycleDetails","freeformTags","definedTags","systemTags"}) public ReportDefinition(String displayName, String id, String parentId, ReportDefinition.Category category, String description, ReportDefinitionDataSource dataSource, Boolean isSeeded, Integer displayOrder, Date timeCreated, Date timeUpdated, String scimFilter, List<Column> columnInfo, List<ColumnFilter> columnFilters, List<ColumnSorting> columnSortings, List<Summary> summary, String compartmentId, ReportDefinitionLifecycleState lifecycleState, String schedule, ReportDefinition.ScheduledReportMimeType scheduledReportMimeType, Integer scheduledReportRowLimit, String scheduledReportName, String scheduledReportCompartmentId, String recordTimeSpan, List<String> complianceStandards, String lifecycleDetails, Map<String,String> freeformTags, Map<String,Map<String,Object>> definedTags, Map<String,Map<String,Object>> systemTags)
public static ReportDefinition.Builder builder()
Create a new builder.
public ReportDefinition.Builder toBuilder()
public String getDisplayName()
Name of the report definition.
public String getId()
The OCID of the report definition.
public String getParentId()
The OCID of the parent report definition. In the case of seeded report definition, this is same as definition OCID.
public ReportDefinition.Category getCategory()
Specifies the name of the category that this report belongs to.
public String getDescription()
A description of the report definition.
public ReportDefinitionDataSource getDataSource()
Specifies the name of a resource that provides data for the report. For example alerts, events.
public Boolean getIsSeeded()
Signifies whether the definition is seeded or user defined. Values can either be ‘true’ or ‘false’.
public Integer getDisplayOrder()
Specifies how the report definitions are ordered in the display.
public Date getTimeCreated()
Specifies the date and time the report definition was created.
public Date getTimeUpdated()
The date and time the report definition was updated.
public String getScimFilter()
Additional SCIM filters used to define the report.
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).
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.
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.
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).
public String getCompartmentId()
The OCID of the compartment containing the report definition.
public ReportDefinitionLifecycleState getLifecycleState()
The current state of the report.
public String getSchedule()
The schedule to generate the report periodically in the specified format:
Allowed version strings - "v1" v1's version specific schedule -
public ReportDefinition.ScheduledReportMimeType getScheduledReportMimeType()
Specifies the format of the report ( either .xls or .pdf or .json)
public Integer getScheduledReportRowLimit()
Specifies the limit on the number of rows in the report.
public String getScheduledReportName()
The name of the report to be scheduled.
public String getScheduledReportCompartmentId()
The OCID of the compartment in which the scheduled resource will be created.
public String getRecordTimeSpan()
The time span for the records in the report to be scheduled.
public List<String> getComplianceStandards()
The list of the data protection regulations/standards used in the report that will help demonstrate compliance.
public String getLifecycleDetails()
Details about the current state of the report definition in Data Safe.
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"}
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"}}
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"}}
public String toString()
toString in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic String toString(boolean includeByteArrayContents)
Return a string representation of the object.
includeByteArrayContents - true to include the full contents of byte arrayspublic boolean equals(Object o)
equals in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelpublic int hashCode()
hashCode in class com.oracle.bmc.http.client.internal.ExplicitlySetBmcModelCopyright © 2016–2024. All rights reserved.