Class ListReferentialRelationsRequest

Inheritance

object

ListReferentialRelationsRequest

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

Assembly: OCI.DotNetSDK.Datasafe.dll

Syntax

public class ListReferentialRelationsRequest : IOciRequest

Examples

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

Properties

ColumnName

Declaration

[HttpConverter(TargetEnum.Query, "columnName", CollectionFormatType.Multi)]
public List<string> ColumnName { get; set; }

Property Value

Type	Description
List<string>	A filter to return only a specific column based on column name.

IsSensitive

Declaration

[HttpConverter(TargetEnum.Query, "isSensitive")]
public bool? IsSensitive { get; set; }

Property Value

Type	Description
bool?	Returns referential relations containing sensitive columns when true. Returns referential relations containing non sensitive columns when false.

Limit

Declaration

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

Property Value

Type	Description
int?	For list pagination. The maximum number of items to return per page in a paginated "List" call. For details about how pagination works, see List Pagination.

ObjectName

Declaration

[HttpConverter(TargetEnum.Query, "objectName", CollectionFormatType.Multi)]
public List<string> ObjectName { get; set; }

Property Value

Type	Description
List<string>	A filter to return only items related to a specific object name.

OpcRequestId

Declaration

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

Property Value

Type	Description
string	Unique identifier for the request.

Page

Declaration

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

Property Value

Type	Description
string	For list pagination. The page token representing the page at which to start retrieving results. It is usually retrieved from a previous "List" call. For details about how pagination works, see List Pagination.

RelationType

Declaration

[HttpConverter(TargetEnum.Query, "relationType", CollectionFormatType.Multi)]
public List<ListReferentialRelationsRequest.RelationTypeEnum> RelationType { get; set; }

Property Value

Type	Description
List<ListReferentialRelationsRequest.RelationTypeEnum>	A filter to return sensitive columns based on their relationship with their parent columns. If set to NONE, it returns the sensitive columns that do not have any parent. The response includes the parent columns as well as the independent columns that are not in any relationship. If set to APP_DEFINED, it returns all the child columns that have application-level (non-dictionary) relationship with their parents. If set to DB_DEFINED, it returns all the child columns that have database-level (dictionary-defined) relationship with their parents.

Type

Description

List<ListReferentialRelationsRequest.RelationTypeEnum>

A filter to return sensitive columns based on their relationship with their parent columns. If set to NONE, it returns the sensitive columns that do not have any parent. The response includes the parent columns as well as the independent columns that are not in any relationship. If set to APP_DEFINED, it returns all the child columns that have application-level (non-dictionary) relationship with their parents. If set to DB_DEFINED, it returns all the child columns that have database-level (dictionary-defined) relationship with their parents.

SchemaName

Declaration

[HttpConverter(TargetEnum.Query, "schemaName", CollectionFormatType.Multi)]
public List<string> SchemaName { get; set; }

Property Value

Type	Description
List<string>	A filter to return only items related to specific schema name.

SensitiveDataModelId

Declaration

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

Property Value

Type	Description
string	The OCID of the sensitive data model.

Remarks

Required

SortBy

Declaration

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

Property Value

Type	Description
ListReferentialRelationsRequest.SortByEnum?	The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for key is descending.

SortOrder

Declaration

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

Property Value

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

Implements

IOciRequest