Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListDrProtectionGroupsRequest

example

Click here to see how to use ListDrProtectionGroupsRequest.

Properties

compartmentId

compartmentId: string

The ID (OCID) of the compartment in which to list resources.

Example: {@code ocid1.compartment.oc1..uniqueID}

Optional displayName

displayName: undefined | string

A filter to return only resources that match the given display name.

Example: {@code MyResourceDisplayName}

Optional drProtectionGroupId

drProtectionGroupId: undefined | string

The OCID of the DR protection group. Optional query param.

Example: {@code ocid1.drprotectiongroup.oc1..uniqueID}

Optional lifecycleState

lifecycleState: model.DrProtectionGroupLifecycleState

A filter to return only DR protection groups that match the given lifecycle state.

Optional lifecycleSubState

lifecycleSubState: model.DrProtectionGroupLifecycleSubState

A filter to return only DR protection groups that match the given lifecycle sub-state.

Optional limit

limit: undefined | number

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](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

Example: {@code 100}

Optional opcRequestId

opcRequestId: undefined | string

The client request ID for tracing.

Optional page

page: undefined | string

For list pagination. The value of the {@code opc-next-page} response header from the previous "List" call.

For important details about how pagination works, see [List Pagination](https://docs.cloud.oracle.com/iaas/Content/API/Concepts/usingapi.htm#nine).

Optional retryConfiguration

retryConfiguration: RetryConfiguration

RetryConfiguration to be used for the request NOTE : Retries are not supported for requests that have binary or stream bodies this also affects UploadManager operations For all requests with binary/stream bodies, retry attempts are not made

Optional role

role: model.DrProtectionGroupRole

The DR protection group Role.

Optional sortBy

sortBy: SortBy

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: {@code MyResourceDisplayName}

Optional sortOrder

sortOrder: model.SortOrder

The sort order to use, either 'asc' or 'desc'.