Class ListAccessRulesFilters

Namespace

Cloudflare.NET.Security.Firewall.Models

Assembly

Cloudflare.NET.dll

Defines the filtering and pagination options for listing IP Access Rules.

public record ListAccessRulesFilters : IEquatable<ListAccessRulesFilters>

Inheritance

object

ListAccessRulesFilters

Implements

IEquatable<ListAccessRulesFilters>

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ListAccessRulesFilters(string?, AccessRuleMode?, FilterMatch?, AccessRuleTarget?, string?, int?, int?, AccessRuleOrderField?, ListOrderDirection?)

Defines the filtering and pagination options for listing IP Access Rules.

public ListAccessRulesFilters(string? Notes = null, AccessRuleMode? Mode = null, FilterMatch? Match = null, AccessRuleTarget? ConfigurationTarget = null, string? ConfigurationValue = null, int? Page = null, int? PerPage = null, AccessRuleOrderField? Order = null, ListOrderDirection? Direction = null)

Parameters

Notes string

A case-insensitive substring to match against the rule's notes.

Mode AccessRuleMode?

The exact mode to filter by.

Match FilterMatch?

Whether to match all or any of the provided filters. Default is 'all'.

ConfigurationTarget AccessRuleTarget?

The target to filter by (e.g., ip, country).

ConfigurationValue string

The value for the target to filter by.

Page int?

The page number of the result set.

PerPage int?

The number of rules per page.

Order AccessRuleOrderField?

The field to order the results by.

Direction ListOrderDirection?

The direction to sort the results.

Properties

ConfigurationTarget

The target to filter by (e.g., ip, country).

public AccessRuleTarget? ConfigurationTarget { get; init; }

Property Value

AccessRuleTarget?

ConfigurationValue

The value for the target to filter by.

public string? ConfigurationValue { get; init; }

Property Value

string

Direction

The direction to sort the results.

public ListOrderDirection? Direction { get; init; }

Property Value

ListOrderDirection?

Match

Whether to match all or any of the provided filters. Default is 'all'.

public FilterMatch? Match { get; init; }

Property Value

FilterMatch?

Mode

The exact mode to filter by.

public AccessRuleMode? Mode { get; init; }

Property Value

AccessRuleMode?

Notes

A case-insensitive substring to match against the rule's notes.

public string? Notes { get; init; }

Property Value

string

Order

The field to order the results by.

public AccessRuleOrderField? Order { get; init; }

Property Value

AccessRuleOrderField?

Page

The page number of the result set.

public int? Page { get; init; }

Property Value

int?

PerPage

The number of rules per page.

public int? PerPage { get; init; }

Property Value

int?