com.oracle.bmc.email.requests

Class ListSuppressionsRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.email.requests.ListSuppressionsRequest

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

Example: Click here to see how to use ListSuppressionsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListSuppressionsRequest.Builder
static class	ListSuppressionsRequest.SortBy The field to sort by.

Constructor Summary

Constructors

Constructor and Description
ListSuppressionsRequest()

Method Summary

Modifier and Type	Method and Description
static ListSuppressionsRequest.Builder	builder() Return a new builder for this request object.
boolean	equals(Object o) Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getCompartmentId() The OCID for the compartment.
String	getEmailAddress() The email address of the suppression.
Integer	getLimit() For list pagination.
String	getOpcRequestId() The request ID for tracing from the system
String	getPage() For list pagination.
ListSuppressionsRequest.SortBy	getSortBy() The field to sort by.
SortOrder	getSortOrder() The sort order to use, either ascending or descending order.
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).
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).
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListSuppressionsRequest.Builder	toBuilder() Return an instance of ListSuppressionsRequest.Builder that allows you to modify request properties.
String	toString()

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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.

toBuilder

public ListSuppressionsRequest.Builder toBuilder()

Return an instance of ListSuppressionsRequest.Builder that allows you to modify request properties.

Returns:

instance of ListSuppressionsRequest.Builder that allows you to modify request properties.

builder

public static ListSuppressionsRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

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>