Show / Hide Table of Contents

Class ListLibraryMaskingFormatsRequest

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

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

Properties

AccessLevel

Declaration
[HttpConverter(TargetEnum.Query, "accessLevel")]
public ListLibraryMaskingFormatsRequest.AccessLevelEnum? AccessLevel { get; set; }
Property Value
Type Description
ListLibraryMaskingFormatsRequest.AccessLevelEnum?

Valid values are RESTRICTED and ACCESSIBLE. Default is RESTRICTED. Setting this to ACCESSIBLE returns only those compartments for which the user has INSPECT permissions directly or indirectly (permissions can be on a resource in a subcompartment). When set to RESTRICTED permissions are checked and no partial results are displayed.

CompartmentId

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

A filter to return only resources that match the specified compartment OCID.

Remarks

Required

CompartmentIdInSubtree

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

Default is false. When set to true, the hierarchy of compartments is traversed and all compartments and subcompartments in the tenancy are returned. Depends on the 'accessLevel' setting.

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 specified display name.

LibraryMaskingFormatId

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

A filter to return only the resources that match the specified library masking format OCID.

LibraryMaskingFormatSource

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

A filter to return the library masking format resources based on the value of their source attribute.

LifecycleState

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

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

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.

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.

SortBy

Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListLibraryMaskingFormatsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type Description
ListLibraryMaskingFormatsRequest.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 displayName is ascending. The displayName sort order is case sensitive.

SortOrder

Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListLibraryMaskingFormatsRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type Description
ListLibraryMaskingFormatsRequest.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

Implements

IOciRequest
In this article
Back to top