Class ListRegistrationPoliciesRequest

Inheritance
object
ListRegistrationPoliciesRequest
Implements
Inherited Members
Namespace: Oci.DatasafeService.Requests
Assembly: OCI.DotNetSDK.Datasafe.dll
Syntax
public class ListRegistrationPoliciesRequest : IOciRequest
Examples

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

Properties

AccessLevel

Declaration
[HttpConverter(TargetEnum.Query, "accessLevel")]
public ListRegistrationPoliciesRequest.AccessLevelEnum? AccessLevel { get; set; }
Property Value
Type Description
ListRegistrationPoliciesRequest.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.

ConnectionId

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

Filter to return the registration policies matching the specified connection ID.

ConnectionType

Declaration
[HttpConverter(TargetEnum.Query, "connectionType")]
public PolicyConnectionOption.ConnectionTypeEnum? ConnectionType { get; set; }
Property Value
Type Description
PolicyConnectionOption.ConnectionTypeEnum?

Filter to return the registration policies matching the specified connectionType i.e ONPREM_CONNECTOR or PRIVATE_ENDPOINT.

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.

EnablementLevel

Declaration
[HttpConverter(TargetEnum.Query, "enablementLevel")]
public RegistrationPolicy.EnablementLevelEnum? EnablementLevel { get; set; }
Property Value
Type Description
RegistrationPolicy.EnablementLevelEnum?

Filter registration policies by resource type.

LifecycleState

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

Filter registration policies by their lifecycle state.

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.

RegistrationPolicyId

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

Filter to return the registration policy matching the specified OCID.

ResourceId

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

Filter to return the registration policy matching the specified resource OCID.

SortBy

Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListRegistrationPoliciesRequest.SortByEnum? SortBy { get; set; }
Property Value
Type Description
ListRegistrationPoliciesRequest.SortByEnum?

Field to sort the registration policies by. Only one sort order (sortOrder) can be specified. Defaults to sorting by timeCreated in descending order

SortOrder

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