Show / Hide Table of Contents

Class ListProtectionPoliciesRequest

Inheritance
object
ListProtectionPoliciesRequest
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.RecoveryService.Requests
Assembly: OCI.DotNetSDK.Recovery.dll
Syntax
public class ListProtectionPoliciesRequest : IOciRequest
Examples

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

Properties

CompartmentId

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

The compartment OCID.

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 entire 'displayname' given.

LifecycleState

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

A filter to return only resources their lifecycleState matches the given lifecycleState.

Limit

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

The maximum number of items to return. Specify a value greater than 4.

OpcRequestId

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

Unique identifier for the request.

Owner

Declaration
[HttpConverter(TargetEnum.Query, "owner")]
public ListProtectionPoliciesRequest.OwnerEnum? Owner { get; set; }
Property Value
Type Description
ListProtectionPoliciesRequest.OwnerEnum?

A filter to return only the policies that match the owner as 'Customer' or 'Oracle'.

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.

ProtectionPolicyId

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

The protection policy OCID.

SortBy

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

The field to sort by. You can provide one sort order (sortOrder). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. If you do not specify a value, then TIMECREATED is used as the default sort order. Allowed values are:

  • TIMECREATED
  • DISPLAYNAME

SortOrder

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

The sort order to use, either ascending (ASC) or descending (DESC). Allowed values are:

  • ASC
  • DESC

Implements

IOciRequest
In this article
Back to top