Class ListReportDefinitionsRequest
Implements
Inherited Members
Namespace: Oci.DatasafeService.Requests
Assembly: OCI.DotNetSDK.Datasafe.dll
Syntax
public class ListReportDefinitionsRequest : IOciRequest
Examples
Click here to see an example of how to use ListReportDefinitions request.
Properties
AccessLevel
Declaration
[HttpConverter(TargetEnum.Query, "accessLevel")]
public ListReportDefinitionsRequest.AccessLevelEnum? AccessLevel { get; set; }
Property Value
Type | Description |
---|---|
ListReportDefinitionsRequest.AccessLevelEnum? | Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed. |
Category
Declaration
[HttpConverter(TargetEnum.Query, "category")]
public ListReportDefinitionsRequest.CategoryEnum? Category { get; set; }
Property Value
Type | Description |
---|---|
ListReportDefinitionsRequest.CategoryEnum? | An optional filter to return only resources that match the specified category. |
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return only resources that match the specified compartment OCID. |
Remarks
Required
CompartmentIdInSubtree
Declaration
[HttpConverter(TargetEnum.Query, "compartmentIdInSubtree")]
public bool? CompartmentIdInSubtree { get; set; }
Property Value
Type | Description |
---|---|
bool? | Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting. |
DataSource
Declaration
[HttpConverter(TargetEnum.Query, "dataSource")]
public ReportDefinitionDataSource? DataSource { get; set; }
Property Value
Type | Description |
---|---|
ReportDefinitionDataSource? | Specifies the name of a resource that provides data for the report. For example alerts, events. |
DisplayName
Declaration
[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | The name of the report definition to query. |
IsSeeded
Declaration
[HttpConverter(TargetEnum.Query, "isSeeded")]
public bool? IsSeeded { get; set; }
Property Value
Type | Description |
---|---|
bool? | A boolean flag indicating to list seeded report definitions. Set this parameter to get list of seeded report definitions. |
LifecycleState
Declaration
[HttpConverter(TargetEnum.Query, "lifecycleState")]
public ReportDefinitionLifecycleState? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
ReportDefinitionLifecycleState? | An optional filter to return only resources that match the specified lifecycle state. |
Limit
Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type | Description |
---|---|
int? | For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination. |
OpcRequestId
Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type | Description |
---|---|
string | Unique identifier for the request. |
Page
Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type | Description |
---|---|
string | For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination. |
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListReportDefinitionsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListReportDefinitionsRequest.SortByEnum? | The field used for sorting. Only one sorting parameter order (sortOrder) can be specified. The default order for TIMECREATED is descending. The default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive. |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListReportDefinitionsRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
ListReportDefinitionsRequest.SortOrderEnum? | The sort order to use, either ascending (ASC) or descending (DESC). |