Class ListReportsRequest
Implements
Inherited Members
Namespace: Oci.DatasafeService.Requests
Assembly: OCI.DotNetSDK.Datasafe.dll
Syntax
public class ListReportsRequest : IOciRequest
Examples
Click here to see an example of how to use ListReports request.
Properties
AccessLevel
Declaration
[HttpConverter(TargetEnum.Query, "accessLevel")]
public ListReportsRequest.AccessLevelEnum? AccessLevel { get; set; }
Property Value
Type | Description |
---|---|
ListReportsRequest.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. |
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. |
DisplayName
Declaration
[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }
Property Value
Type | Description |
---|---|
string | The name of the report definition to query. |
LifecycleState
Declaration
[HttpConverter(TargetEnum.Query, "lifecycleState")]
public ReportLifecycleState? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
ReportLifecycleState? | 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. |
MimeType
Declaration
[HttpConverter(TargetEnum.Query, "mimeType")]
public ListReportsRequest.MimeTypeEnum? MimeType { get; set; }
Property Value
Type | Description |
---|---|
ListReportsRequest.MimeTypeEnum? | An optional filter to return only resources that match the specified mime type. |
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. |
ReportDefinitionId
Declaration
[HttpConverter(TargetEnum.Query, "reportDefinitionId")]
public string ReportDefinitionId { get; set; }
Property Value
Type | Description |
---|---|
string | The ID of the report definition to filter the list of reports |
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListReportsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListReportsRequest.SortByEnum? | The field to sort by. Only one sort order may be provided. Default order for timeGenerated is descending. Default order for displayName is ascending. If no value is specified timeGenerated is default. |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListReportsRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
ListReportsRequest.SortOrderEnum? | The sort order to use, either ascending (ASC) or descending (DESC). |
TimeGeneratedGreaterThanOrEqualTo
Declaration
[HttpConverter(TargetEnum.Query, "timeGeneratedGreaterThanOrEqualTo")]
public DateTime? TimeGeneratedGreaterThanOrEqualTo { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | A filter to return only the resources that were generated after the specified date and time, as defined by RFC3339.
Using TimeGeneratedGreaterThanOrEqualToQueryParam parameter retrieves all resources generated after that date.
|
TimeGeneratedLessThan
Declaration
[HttpConverter(TargetEnum.Query, "timeGeneratedLessThan")]
public DateTime? TimeGeneratedLessThan { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | Search for resources that were generated before a specific date.
Specifying this parameter corresponding |
Type
Declaration
[HttpConverter(TargetEnum.Query, "type")]
public ReportType? Type { get; set; }
Property Value
Type | Description |
---|---|
ReportType? | An optional filter to return only resources that match the specified type. |