Class ListRulesRequest

Inheritance
object
ListRulesRequest
Implements
Inherited Members
Namespace: Oci.EventsService.Requests
Assembly: OCI.DotNetSDK.Events.dll
Syntax
public class ListRulesRequest : IOciRequest
Examples

Click here to see an example of how to use ListRules request.

Properties

CompartmentId

Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type Description
string

The OCID of the compartment to which this rule belongs.
Remarks

Required

DisplayName

Declaration
[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }
Property Value
Type Description
string

A filter to return only rules with descriptions that match the displayName string in this parameter.
Example: "This rule sends a notification upon completion of DbaaS backup."

LifecycleState

Declaration
[HttpConverter(TargetEnum.Query, "lifecycleState")]
public Rule.LifecycleStateEnum? LifecycleState { get; set; }
Property Value
Type Description
Rule.LifecycleStateEnum?

A filter to return only rules that match the lifecycle state in this parameter.
Example: Creating

Limit

Declaration
[HttpConverter(TargetEnum.Query, "limit")]
public int? Limit { get; set; }
Property Value
Type Description
int?

The maximum number of items to return. 1 is the minimum, 50 is the maximum. Default: 10

OpcRequestId

Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type Description
string

The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.

Page

Declaration
[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }
Property Value
Type Description
string

For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

SortBy

Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListRulesRequest.SortByEnum? SortBy { get; set; }
Property Value
Type Description
ListRulesRequest.SortByEnum?

Specifies the attribute with which to sort the rules.
Default: timeCreated

  • TIME_CREATED: Sorts by timeCreated.
  • DISPLAY_NAME: Sorts by displayName.
  • ID: Sorts by id.

SortOrder

Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListRulesRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type Description
ListRulesRequest.SortOrderEnum?

Specifies sort order.

  • ASC: Ascending sort order.
  • DESC: Descending sort order.

Implements