Show / Hide Table of Contents

Class ListMaskingColumnsRequest

Inheritance
object
ListMaskingColumnsRequest
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 ListMaskingColumnsRequest : IOciRequest
Examples

Click here to see an example of how to use ListMaskingColumns 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.

DataType

Declaration
[HttpConverter(TargetEnum.Query, "dataType", CollectionFormatType.Multi)]
public List<ListMaskingColumnsRequest.DataTypeEnum> DataType { get; set; }
Property Value
Type Description
List<ListMaskingColumnsRequest.DataTypeEnum>

A filter to return only resources that match the specified data types.

IsMaskingEnabled

Declaration
[HttpConverter(TargetEnum.Query, "isMaskingEnabled")]
public bool? IsMaskingEnabled { get; set; }
Property Value
Type Description
bool?

A filter to return the masking column resources based on the value of their isMaskingEnabled attribute. A value of true returns only those columns for which masking is enabled. A value of false returns only those columns for which masking is disabled. Omitting this parameter returns all the masking columns in a masking policy.

IsSeedRequired

Declaration
[HttpConverter(TargetEnum.Query, "isSeedRequired")]
public bool? IsSeedRequired { get; set; }
Property Value
Type Description
bool?

A filter to return masking columns based on whether the assigned masking formats need a seed value for masking. A value of true returns those masking columns that are using Deterministic Encryption or Deterministic Substitution masking format.

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.

MaskingColumnGroup

Declaration
[HttpConverter(TargetEnum.Query, "maskingColumnGroup", CollectionFormatType.Multi)]
public List<string> MaskingColumnGroup { get; set; }
Property Value
Type Description
List<string>

A filter to return only the resources that match the specified masking column group.

MaskingColumnLifecycleState

Declaration
[HttpConverter(TargetEnum.Query, "maskingColumnLifecycleState")]
public MaskingColumnLifecycleState? MaskingColumnLifecycleState { get; set; }
Property Value
Type Description
MaskingColumnLifecycleState?

A filter to return only the resources that match the specified lifecycle states.

MaskingPolicyId

Declaration
[Required(ErrorMessage = "MaskingPolicyId is required.")]
[HttpConverter(TargetEnum.Path, "maskingPolicyId")]
public string MaskingPolicyId { get; set; }
Property Value
Type Description
string

The OCID of the masking policy.

Remarks

Required

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<ListMaskingColumnsRequest.ObjectTypeEnum> ObjectType { get; set; }
Property Value
Type Description
List<ListMaskingColumnsRequest.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.

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.

SensitiveTypeId

Declaration
[HttpConverter(TargetEnum.Query, "sensitiveTypeId")]
public string SensitiveTypeId { get; set; }
Property Value
Type Description
string

A filter to return only items related to a specific sensitive type OCID.

SortBy

Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListMaskingColumnsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type Description
ListMaskingColumnsRequest.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 other fields is ascending.

SortOrder

Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListMaskingColumnsRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type Description
ListMaskingColumnsRequest.SortOrderEnum?

The sort order to use, either ascending (ASC) or descending (DESC).

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.
**Example: ** 2016-12-19T16:39:57.600Z

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 timeCreatedLessThan parameter will retrieve all resources created before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.
**Example: ** 2016-12-19T16:39:57.600Z

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 timeUpdatedGreaterThanOrEqualTo parameter will retrieve all resources updated after the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

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 timeUpdatedLessThan parameter will retrieve all resources updated before the specified created date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

Implements

IOciRequest
In this article
Back to top