Class ListDrPlansRequest

Inheritance

object

ListDrPlansRequest

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.DisasterrecoveryService.Requests

Assembly: OCI.DotNetSDK.Disasterrecovery.dll

Syntax

public class ListDrPlansRequest : IOciRequest

Examples

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

Properties

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 given display name. Example: MyResourceDisplayName

DrPlanId

Declaration

[HttpConverter(TargetEnum.Query, "drPlanId")]
public string DrPlanId { get; set; }

Property Value

Type	Description
string	The OCID of the DR plan. Example: ocid1.drplan.oc1..uniqueID

DrPlanType

Declaration

[HttpConverter(TargetEnum.Query, "drPlanType")]
public DrPlanType? DrPlanType { get; set; }

Property Value

Type	Description
DrPlanType?	The DR plan type.

DrProtectionGroupId

Declaration

[Required(ErrorMessage = "DrProtectionGroupId is required.")]
[HttpConverter(TargetEnum.Query, "drProtectionGroupId")]
public string DrProtectionGroupId { get; set; }

Property Value

Type	Description
string	The OCID of the DR protection group. Mandatory query param. Example: ocid1.drprotectiongroup.oc1..uniqueID

Remarks

Required

LifecycleState

Declaration

[HttpConverter(TargetEnum.Query, "lifecycleState")]
public DrPlanLifecycleState? LifecycleState { get; set; }

Property Value

Type	Description
DrPlanLifecycleState?	A filter to return only DR plans that match the given lifecycle state.

LifecycleSubState

Declaration

[HttpConverter(TargetEnum.Query, "lifecycleSubState")]
public DrPlanLifecycleSubState? LifecycleSubState { get; set; }

Property Value

Type	Description
DrPlanLifecycleSubState?	A filter to return only DR plans that match the given lifecycle sub-state.

Limit

Declaration

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

Property Value

Type	Description
int?	For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. 1 is the minimum, 1000 is the maximum. For important details about how pagination works, see List Pagination. Example: 100

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	For list pagination. The value of the opc-next-page response header from the previous "List" call. For important details about how pagination works, see List Pagination.

SortBy

Declaration

[HttpConverter(TargetEnum.Query, "sortBy")]
public ListDrPlansRequest.SortByEnum? SortBy { get; set; }

Property Value

Type	Description
ListDrPlansRequest.SortByEnum?	The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default. Example: MyResourceDisplayName

SortOrder

Declaration

[HttpConverter(TargetEnum.Query, "sortOrder")]
public SortOrder? SortOrder { get; set; }

Property Value

Type	Description
SortOrder?	The sort order to use, either 'asc' or 'desc'.

Implements

IOciRequest