Package com.oracle.bmc.email.requests

Class ListSuppressionsRequest

  • @Generated(value="OracleSDKGenerator",
           comments="API Version: 20170907")
public class ListSuppressionsRequest
extends BmcRequest<Void>

    Example: Click <a href=“https://docs.oracle.com/en-us/iaas/tools/java-sdk-examples/3.63.1/email/ListSuppressionsExample.java.html"target=”_blank"rel=“noopener noreferrer”>here to see how to use ListSuppressionsRequest.

    • Constructor Detail

      • ListSuppressionsRequest

        public ListSuppressionsRequest()

    • Method Detail

      • getCompartmentId

        public String getCompartmentId()
        The OCID for the compartment.

      • getOpcRequestId

        public String getOpcRequestId()
        The request ID for tracing from the system

      • getEmailAddress

        public String getEmailAddress()
        The email address of the suppression.

      • getTimeCreatedGreaterThanOrEqualTo

        public Date getTimeCreatedGreaterThanOrEqualTo()
        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 parameter will retrieve suppressions created from the given 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

      • getTimeCreatedLessThan

        public Date getTimeCreatedLessThan()
        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 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

      • getPage

        public String getPage()
        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.

      • getLimit

        public Integer getLimit()
        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.

      • getSortBy

        public ListSuppressionsRequest.SortBy getSortBy()
        The field to sort by.

        The TIMECREATED value returns the list in in descending order by default. The EMAILADDRESS value returns the list in ascending order by default. Use the SortOrderQueryParam to change the direction of the returned list of items.

      • getSortOrder

        public SortOrder getSortOrder()
        The sort order to use, either ascending or descending order.

      • equals

        public boolean equals​(Object o)
        Description copied from class: BmcRequest
        Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
        Overrides:
        equals in class BmcRequest<Void>

      • hashCode

        public int hashCode()
        Description copied from class: BmcRequest
        Uses getInvocationCallback and getRetryConfiguration to generate a hash.
        Overrides:
        hashCode in class BmcRequest<Void>