Class ListRulesRequest

Inheritance

object

ListRulesRequest

Implements

IOciRequest

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Namespace: Oci.LoganalyticsService.Requests

Assembly: OCI.DotNetSDK.Loganalytics.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 ID of the compartment in which to list resources.

Remarks

Required

DisplayName

Declaration

[HttpConverter(TargetEnum.Query, "displayName")]
public string DisplayName { get; set; }

Property Value

Type	Description
string	A filter to return rules whose displayName matches in whole or in part the specified value. The match is case-insensitive.

Kind

Declaration

[HttpConverter(TargetEnum.Query, "kind")]
public ListRulesRequest.KindEnum? Kind { get; set; }

Property Value

Type	Description
ListRulesRequest.KindEnum?	The rule kind used for filtering. Only rules of the specified kind will be returned.

LifecycleState

Declaration

[HttpConverter(TargetEnum.Query, "lifecycleState")]
public ConfigLifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
ConfigLifecycleState?	The rule lifecycle state used for filtering. Currently supported values are ACTIVE and DELETED.

Limit

Declaration

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

Property Value

Type	Description
int?	The maximum number of items to return.

NamespaceName

Declaration

[Required(ErrorMessage = "NamespaceName is required.")]
[HttpConverter(TargetEnum.Path, "namespaceName")]
public string NamespaceName { get; set; }

Property Value

Type	Description
string	The Logging Analytics namespace used for the request.

Remarks

Required

OpcRequestId

Declaration

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

Property Value

Type	Description
string	The client request ID for tracing.

Page

Declaration

[HttpConverter(TargetEnum.Query, "page")]
public string Page { get; set; }

Property Value

Type	Description
string	The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

SortBy

Declaration

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

Property Value

Type	Description
ListRulesRequest.SortByEnum?	The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

SortOrder

Declaration

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

Property Value

Type	Description
ListRulesRequest.SortOrderEnum?	The sort order to use, either ascending (ASC) or descending (DESC).

TargetService

Declaration

[HttpConverter(TargetEnum.Query, "targetService")]
public string TargetService { get; set; }

Property Value

Type	Description
string	The target service to use for filtering.

Implements

IOciRequest