Class ListSensitiveColumnsRequest
Implements
Inherited Members
Namespace: Oci.DatasafeService.Requests
Assembly: OCI.DotNetSDK.Datasafe.dll
Syntax
public class ListSensitiveColumnsRequest : IOciRequest
Examples
Click here to see an example of how to use ListSensitiveColumns request.
Properties
ColumnGroup
Declaration
[HttpConverter(TargetEnum.Query, "columnGroup")]
public string ColumnGroup { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return only the sensitive columns that belong to the specified column group. |
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. |
DataType
Declaration
[HttpConverter(TargetEnum.Query, "dataType", CollectionFormatType.Multi)]
public List<string> DataType { get; set; }
Property Value
Type | Description |
---|---|
List<string> | A filter to return only the resources that match the specified data types. |
IsCaseInSensitive
Declaration
[HttpConverter(TargetEnum.Query, "isCaseInSensitive")]
public bool? IsCaseInSensitive { get; set; }
Property Value
Type | Description |
---|---|
bool? | A boolean flag indicating whether the search should be case-insensitive. The search is case-sensitive by default. Set this parameter to true to do case-insensitive search. |
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. |
ObjectType
Declaration
[HttpConverter(TargetEnum.Query, "objectType", CollectionFormatType.Multi)]
public List<ListSensitiveColumnsRequest.ObjectTypeEnum> ObjectType { get; set; }
Property Value
Type | Description |
---|---|
List<ListSensitiveColumnsRequest.ObjectTypeEnum> | A filter to return only items related to a specific object type. |
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. |
ParentColumnKey
Declaration
[HttpConverter(TargetEnum.Query, "parentColumnKey", CollectionFormatType.Multi)]
public List<string> ParentColumnKey { get; set; }
Property Value
Type | Description |
---|---|
List<string> | A filter to return only the sensitive columns that are children of one of the columns identified by the specified keys. |
RelationType
Declaration
[HttpConverter(TargetEnum.Query, "relationType", CollectionFormatType.Multi)]
public List<ListSensitiveColumnsRequest.RelationTypeEnum> RelationType { get; set; }
Property Value
Type | Description |
---|---|
List<ListSensitiveColumnsRequest.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. |
SensitiveColumnLifecycleState
Declaration
[HttpConverter(TargetEnum.Query, "sensitiveColumnLifecycleState")]
public SensitiveColumnLifecycleState? SensitiveColumnLifecycleState { get; set; }
Property Value
Type | Description |
---|---|
SensitiveColumnLifecycleState? | Filters the sensitive column resources with the given lifecycle state values. |
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
SensitiveTypeId
Declaration
[HttpConverter(TargetEnum.Query, "sensitiveTypeId", CollectionFormatType.Multi)]
public List<string> SensitiveTypeId { get; set; }
Property Value
Type | Description |
---|---|
List<string> | A filter to return only the sensitive columns that are associated with one of the sensitive types identified by the specified OCIDs. |
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListSensitiveColumnsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListSensitiveColumnsRequest.SortByEnum? | The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeCreated is descending. The default order for schemaName, objectName, and columnName is ascending. |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListSensitiveColumnsRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
ListSensitiveColumnsRequest.SortOrderEnum? | The sort order to use, either ascending (ASC) or descending (DESC). |
Status
Declaration
[HttpConverter(TargetEnum.Query, "status", CollectionFormatType.Multi)]
public List<ListSensitiveColumnsRequest.StatusEnum> Status { get; set; }
Property Value
Type | Description |
---|---|
List<ListSensitiveColumnsRequest.StatusEnum> | A filter to return only the sensitive columns that match the specified status. |
TimeCreatedGreaterThanOrEqualTo
Declaration
[HttpConverter(TargetEnum.Query, "timeCreatedGreaterThanOrEqualTo")]
public DateTime? TimeCreatedGreaterThanOrEqualTo { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | A filter to return only the resources that were created after the specified date and time, as defined by RFC3339.
Using TimeCreatedGreaterThanOrEqualToQueryParam parameter retrieves all resources created after that date.
|
TimeCreatedLessThan
Declaration
[HttpConverter(TargetEnum.Query, "timeCreatedLessThan")]
public DateTime? TimeCreatedLessThan { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | Search for resources that were created before a specific date.
Specifying this parameter corresponding |
TimeUpdatedGreaterThanOrEqualTo
Declaration
[HttpConverter(TargetEnum.Query, "timeUpdatedGreaterThanOrEqualTo")]
public DateTime? TimeUpdatedGreaterThanOrEqualTo { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | Search for resources that were updated after a specific date.
Specifying this parameter corresponding |
TimeUpdatedLessThan
Declaration
[HttpConverter(TargetEnum.Query, "timeUpdatedLessThan")]
public DateTime? TimeUpdatedLessThan { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | Search for resources that were updated before a specific date.
Specifying this parameter corresponding |