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.DatacatalogService.Requests

Assembly: OCI.DotNetSDK.Datacatalog.dll

Syntax

public class ListRulesRequest : IOciRequest

Examples

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

Properties

CatalogId

Declaration

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

Property Value

Type	Description
string	Unique catalog identifier.

Remarks

Required

CreatedById

Declaration

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

Property Value

Type	Description
string	OCID of the user who created the resource.

DataAssetKey

Declaration

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

Property Value

Type	Description
string	Unique data asset key.

Remarks

Required

DisplayName

Declaration

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

Property Value

Type	Description
string	A filter to return only resources that match the entire display name given. The match is not case sensitive.

DisplayNameContains

Declaration

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

Property Value

Type	Description
string	A filter to return only resources that match display name pattern given. The match is not case sensitive. For Example : /folders?displayNameContains=Cu.* The above would match all folders with display name that starts with "Cu" or has the pattern "Cu" anywhere in between.

EntityKey

Declaration

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

Property Value

Type	Description
string	Unique entity key.

Remarks

Required

ExternalKey

Declaration

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

Property Value

Type	Description
string	Unique external identifier of this resource in the external source system.

Fields

Declaration

[HttpConverter(TargetEnum.Query, "fields", CollectionFormatType.Multi)]
public List<ListRulesRequest.FieldsEnum> Fields { get; set; }

Property Value

Type	Description
List<ListRulesRequest.FieldsEnum>	Specifies the fields to return in a rule summary response.

LifecycleState

Declaration

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

Property Value

Type	Description
LifecycleState?	A filter to return only resources that match the specified lifecycle state. The value is case insensitive.

Limit

Declaration

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

Property Value

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

OpcRequestId

Declaration

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

Property Value

Type	Description
string	The client request ID for tracing.

OriginType

Declaration

[HttpConverter(TargetEnum.Query, "originType")]
public RuleOriginType? OriginType { get; set; }

Property Value

Type	Description
RuleOriginType?	Rule origin type used to filter the response to a list rules call.

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.

RuleType

Declaration

[HttpConverter(TargetEnum.Query, "ruleType")]
public RuleType? RuleType { get; set; }

Property Value

Type	Description
RuleType?	Rule type used to filter the response to a list rules 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 'asc' or 'desc'.

TimeCreated

Declaration

[HttpConverter(TargetEnum.Query, "timeCreated")]
public DateTime? TimeCreated { get; set; }

Property Value

Type	Description
DateTime?	Time that the resource was created. An RFC3339 formatted datetime string.

TimeUpdated

Declaration

[HttpConverter(TargetEnum.Query, "timeUpdated")]
public DateTime? TimeUpdated { get; set; }

Property Value

Type	Description
DateTime?	Time that the resource was updated. An RFC3339 formatted datetime string.

UpdatedById

Declaration

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

Property Value

Type	Description
string	OCID of the user who updated the resource.

Implements

IOciRequest