Class ListCryptoAssessmentsRequest

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

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

Properties

AccessLevel

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

AssessmentId

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

A filter to return only resources associated with the specified crypto assessment OCID.

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.

IsAssessmentScheduled

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

A filter to return only crypto assessments whose scheduled execution state matches the specified value.

LifecycleState

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

A filter to return only 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.

PostureCategory

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

A filter to return only crypto assessments that match any of the specified posture categories.

SortBy

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

The field used to sort crypto assessments. You can specify only one sort order (sortOrder).

SortOrder

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

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

TargetDatabaseGroupId

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

A filter to return the target database group that matches the specified OCID.

TargetId

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

A filter to return only crypto assessments associated with the specified target OCID. When provided, targetType must also be specified.

TargetIds

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

A filter to return only resources associated with any of the specified target OCIDs.

TargetType

Declaration
[HttpConverter(TargetEnum.Query, "targetType")]
public CryptoAssessment.TargetTypeEnum? TargetType { get; set; }
Property Value
Type Description
CryptoAssessment.TargetTypeEnum?

A filter to return crypto assessments belonging to the specified target type. ListCryptoAssessments returns assessment rows; use targetDatabaseGroupId to list the underlying target database assessments for a group.

Type

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

A filter to return only crypto assessments that match the specified type.

Implements