Show / Hide Table of Contents

Class ListResponderExecutionsRequest

Inheritance
object
ListResponderExecutionsRequest
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.CloudguardService.Requests
Assembly: OCI.DotNetSDK.Cloudguard.dll
Syntax
public class ListResponderExecutionsRequest : IOciRequest
Examples

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

Properties

AccessLevel

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

The OCID of the compartment in which to list resources.

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 depending on the setting of accessLevel.

Limit

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

The maximum number of items to return

OpcRequestId

Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type Description
string

The client request ID for tracing.

Page

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

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

ResourceType

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

Resource type associated with the resource.

ResponderExecutionMode

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

The mode of the responder execution in which to list responders.

ResponderExecutionStatus

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

The status of the responder execution in which to list responders.

ResponderRuleIds

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

Responder rule unique identifier filter for the responder executions.

ResponderType

Declaration
[HttpConverter(TargetEnum.Query, "responderType")]
public ListResponderExecutionsRequest.ResponderTypeEnum? ResponderType { get; set; }
Property Value
Type Description
ListResponderExecutionsRequest.ResponderTypeEnum?

The field to list the responder executions by responder type. Valid values are REMEDIATION and NOTIFICATION.

SortBy

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

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for responderRuleName and resourceName is ascending. If no value is specified timeCreated is default.

SortOrder

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

The sort order to use

TargetId

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

The ID of the target in which to list resources.

TimeCompletedGreaterThanOrEqualTo

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

Completion end time.

TimeCompletedLessThanOrEqualTo

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

Completion start time.

TimeCreatedGreaterThanOrEqualTo

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

Creation start time for filtering

TimeCreatedLessThanOrEqualTo

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

Creation end time for filtering.

Implements

IOciRequest
In this article
Back to top