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