Class ListSuppressionsRequest
Implements
Inherited Members
Namespace: Oci.EmailService.Requests
Assembly: OCI.DotNetSDK.Email.dll
Syntax
public class ListSuppressionsRequest : IOciRequest
Examples
Click here to see an example of how to use ListSuppressions request.
Properties
CompartmentId
Declaration
[Required(ErrorMessage = "CompartmentId is required.")]
[HttpConverter(TargetEnum.Query, "compartmentId")]
public string CompartmentId { get; set; }
Property Value
Type | Description |
---|---|
string | The OCID for the compartment. |
Remarks
Required
EmailAddress
Declaration
[HttpConverter(TargetEnum.Query, "emailAddress")]
public string EmailAddress { get; set; }
Property Value
Type | Description |
---|---|
string | The email address of the suppression. |
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. |
OpcRequestId
Declaration
[HttpConverter(TargetEnum.Header, "opc-request-id")]
public string OpcRequestId { get; set; }
Property Value
Type | Description |
---|---|
string | The request ID for tracing from the system |
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 ListSuppressionsRequest.SortByEnum? SortBy { get; set; }
Property Value
Type | Description |
---|---|
ListSuppressionsRequest.SortByEnum? | The field to sort by. The |
SortOrder
Declaration
[HttpConverter(TargetEnum.Query, "sortOrder")]
public SortOrder? SortOrder { get; set; }
Property Value
Type | Description |
---|---|
SortOrder? | The sort order to use, either ascending or descending order. |
TimeCreatedGreaterThanOrEqualTo
Declaration
[HttpConverter(TargetEnum.Query, "timeCreatedGreaterThanOrEqualTo")]
public DateTime? TimeCreatedGreaterThanOrEqualTo { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | 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 |
TimeCreatedLessThan
Declaration
[HttpConverter(TargetEnum.Query, "timeCreatedLessThan")]
public DateTime? TimeCreatedLessThan { get; set; }
Property Value
Type | Description |
---|---|
DateTime? | 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
|