Options
All
  • Public
  • Public/Protected
  • All
Menu

Namespace ListSuppressionsRequest

example

Click here to see how to use ListSuppressionsRequest.

Properties

compartmentId

compartmentId: string

The OCID for the compartment.

Optional emailAddress

emailAddress: undefined | string

The email address of the suppression.

Optional limit

limit: undefined | number

For list pagination. The maximum number of results per page, or items to return in a paginated "List" call. {@code 1} is the minimum, {@code 1000} is the maximum. For important details about how pagination works, see List Pagination.

Optional opcRequestId

opcRequestId: undefined | string

The request ID for tracing from the system

Optional page

page: undefined | 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.

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 sortBy

sortBy: SortBy

The field to sort by. The {@code TIMECREATED} value returns the list in in descending order by default. The {@code EMAILADDRESS} value returns the list in ascending order by default. Use the {@code SortOrderQueryParam} to change the direction of the returned list of items.

Optional sortOrder

sortOrder: model.SortOrder

The sort order to use, either ascending or descending order.

Optional timeCreatedGreaterThanOrEqualTo

timeCreatedGreaterThanOrEqualTo: Date

Search for suppressions that were created within a specific date range, using this parameter to specify the earliest creation date for the returned list (inclusive). Specifying this parameter without the corresponding {@code timeCreatedLessThan} parameter will retrieve suppressions created from the given {@code timeCreatedGreaterThanOrEqualTo} to the current time, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

*Example:** 2016-12-19T16:39:57.600Z

Optional timeCreatedLessThan

timeCreatedLessThan: Date

Search for suppressions that were created within a specific date range, using this parameter to specify the latest creation date for the returned list (exclusive). Specifying this parameter without the corresponding {@code timeCreatedGreaterThanOrEqualTo} parameter will retrieve all suppressions created before the specified end date, in "YYYY-MM-ddThh:mmZ" format with a Z offset, as defined by RFC 3339.

*Example:** 2016-12-19T16:39:57.600Z