@Generated(value="OracleSDKGenerator", comments="API Version: 20170907") public class ListSuppressionsRequest extends BmcRequest
Modifier and Type | Class and Description |
---|---|
static class |
ListSuppressionsRequest.Builder |
static class |
ListSuppressionsRequest.SortBy
The field to sort by.
|
static class |
ListSuppressionsRequest.SortOrder
The sort order to use, either ascending or descending order.
|
Modifier and Type | Method and Description |
---|---|
static ListSuppressionsRequest.Builder |
builder() |
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.
|
ListSuppressionsRequest.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).
|
getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration
public static ListSuppressionsRequest.Builder builder()
public String getCompartmentId()
The OCID for the compartment.
public String getOpcRequestId()
The request ID for tracing from the system
public String getEmailAddress()
The email address of the suppression.
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
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
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.
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.
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.
public ListSuppressionsRequest.SortOrder getSortOrder()
The sort order to use, either ascending or descending order.
Copyright © 2016–2019. All rights reserved.