Class ListAuditEventAnalyticsRequest
Implements
Inherited Members
Namespace: Oci.DatasafeService.Requests
Assembly: OCI.DotNetSDK.Datasafe.dll
Syntax
public class ListAuditEventAnalyticsRequest : IOciRequest
Examples
Click here to see an example of how to use ListAuditEventAnalytics request.
Properties
AccessLevel
Declaration
[HttpConverter(TargetEnum.Query, "accessLevel")]
public ListAuditEventAnalyticsRequest.AccessLevelEnum? AccessLevel { get; set; }
Property Value
Type | Description |
---|---|
ListAuditEventAnalyticsRequest.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. |
GroupBy
Declaration
[HttpConverter(TargetEnum.Query, "groupBy", CollectionFormatType.Multi)]
public List<ListAuditEventAnalyticsRequest.GroupByEnum> GroupBy { get; set; }
Property Value
Type | Description |
---|---|
List<ListAuditEventAnalyticsRequest.GroupByEnum> | A groupBy can only be used in combination with summaryField parameter. A groupBy value has to be a subset of the values mentioned in summaryField parameter. |
IfMatch
Declaration
[HttpConverter(TargetEnum.Header, "if-match")]
public string IfMatch { get; set; }
Property Value
Type | Description |
---|---|
string | For optimistic concurrency control. In the PUT or DELETE call for a resource, set the if-match parameter to the value of the etag from a previous GET or POST response for that resource. The resource will be updated or deleted only if the etag you provide matches the resource's current etag value. |
Limit
Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type | Description |
---|---|
int? | 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. |
OpcRetryToken
Declaration
[HttpConverter(TargetEnum.Header, "opc-retry-token")]
public string OpcRetryToken { get; set; }
Property Value
Type | Description |
---|---|
string | A token that uniquely identifies a request so it can be retried in case of a timeout or server error without risk of executing that same action again. Retry tokens expire after 24 hours, but can be invalidated before then due to conflicting operations. For example, if a resource has been deleted and purged from the system, then a retry of the original creation request might be rejected. |
Page
Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type | Description |
---|---|
string | It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination. |
QueryTimeZone
Declaration
[HttpConverter(TargetEnum.Query, "queryTimeZone")]
public string QueryTimeZone { get; set; }
Property Value
Type | Description |
---|---|
string | Default time zone is UTC if no time zone provided. The date-time considerations of the resource will be in accordance with the specified time zone. |
ScimQuery
Declaration
[HttpConverter(TargetEnum.Query, "scimQuery")]
public string ScimQuery { get; set; }
Property Value
Type | Description |
---|---|
string | The scimQuery query parameter accepts filter expressions that use the syntax described in Section 3.2.2.2
of the System for Cross-Domain Identity Management (SCIM) specification, which is available
at RFC3339. In SCIM filtering expressions,
text, date, and time values must be enclosed in quotation marks, with date and time values using ISO-8601 format.
(Numeric and boolean values should not be quoted.)
|
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListAuditEventAnalyticsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListAuditEventAnalyticsRequest.SortByEnum? | If this query parameter is specified, the result is ordered based on this query parameter value. |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListAuditEventAnalyticsRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
ListAuditEventAnalyticsRequest.SortOrderEnum? | The sort order to use, either ascending (ASC) or descending (DESC). |
SummaryField
Declaration
[HttpConverter(TargetEnum.Query, "summaryField", CollectionFormatType.Multi)]
public List<ListAuditEventAnalyticsRequest.SummaryFieldEnum> SummaryField { get; set; }
Property Value
Type | Description |
---|---|
List<ListAuditEventAnalyticsRequest.SummaryFieldEnum> | Specifies a subset of summarized fields to be returned in the response. |
TimeEnded
Declaration
[HttpConverter(TargetEnum.Query, "timeEnded")]
public DateTime? TimeEnded { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | An optional filter to return audit events whose creation time in the database is less than and equal to the date-time specified, in the format defined by RFC3339. |
TimeStarted
Declaration
[HttpConverter(TargetEnum.Query, "timeStarted")]
public DateTime? TimeStarted { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | An optional filter to return audit events whose creation time in the database is greater than and equal to the date-time specified, in the format defined by RFC3339. |