Class ListDrProtectionGroupsRequest

Inheritance

object

ListDrProtectionGroupsRequest

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 ListDrProtectionGroupsRequest : IOciRequest

Examples

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

Properties

CompartmentId

Declaration

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

Property Value

Type	Description
string	The ID (OCID) of the compartment in which to list resources. Example: ocid1.compartment.oc1..uniqueID

Remarks

Required

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

DrProtectionGroupId

Declaration

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

Property Value

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

LifecycleState

Declaration

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

Property Value

Type	Description
DrProtectionGroupLifecycleState?	A filter to return only DR protection groups that match the given lifecycle state.

LifecycleSubState

Declaration

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

Property Value

Type	Description
DrProtectionGroupLifecycleSubState?	A filter to return only DR protection groups 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.

Role

Declaration

[HttpConverter(TargetEnum.Query, "role")]
public DrProtectionGroupRole? Role { get; set; }

Property Value

Type	Description
DrProtectionGroupRole?	The DR protection group Role.

SortBy

Declaration

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

Property Value

Type	Description
ListDrProtectionGroupsRequest.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