Class ListDiscoveryJobsRequest
Implements
Inherited Members
Namespace: Oci.DatasafeService.Requests
Assembly: OCI.DotNetSDK.Datasafe.dll
Syntax
public class ListDiscoveryJobsRequest : IOciRequest
Examples
Click here to see an example of how to use ListDiscoveryJobs request.
Properties
AccessLevel
Declaration
[HttpConverter(TargetEnum.Query, "accessLevel")]
public ListDiscoveryJobsRequest.AccessLevelEnum? AccessLevel { get; set; }
Property Value
Type | Description |
---|---|
ListDiscoveryJobsRequest.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. |
DiscoveryJobId
Declaration
[HttpConverter(TargetEnum.Query, "discoveryJobId")]
public string DiscoveryJobId { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return only the resources that match the specified discovery job OCID. |
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. |
LifecycleState
Declaration
[HttpConverter(TargetEnum.Query, "lifecycleState")]
public DiscoveryLifecycleState? LifecycleState { get; set; }
Property Value
Type | Description |
---|---|
DiscoveryLifecycleState? | A filter to return only the resources that match the specified 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. |
SensitiveDataModelId
Declaration
[HttpConverter(TargetEnum.Query, "sensitiveDataModelId")]
public string SensitiveDataModelId { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return only the resources that match the specified sensitive data model OCID. |
SortBy
Declaration
[HttpConverter(TargetEnum.Query, "sortBy")]
public ListDiscoveryJobsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListDiscoveryJobsRequest.SortByEnum? | The field to sort by. You can specify only one sorting parameter (sortOrder). The default order for timeFinished is descending. The default order for displayName is ascending. |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public ListDiscoveryJobsRequest.SortOrderEnum? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
ListDiscoveryJobsRequest.SortOrderEnum? | The sort order to use, either ascending (ASC) or descending (DESC). |
TargetId
Declaration
[HttpConverter(TargetEnum.Query, "targetId")]
public string TargetId { get; set; }
Property Value
Type | Description |
---|---|
string | A filter to return only items related to a specific target OCID. |