@Generated(value="OracleSDKGenerator",
comments="API Version: 20170907")
public class ListSendersRequest
extends BmcRequest<Void>
Example: Click here to see how to use ListSendersRequest.
| Modifier and Type | Class and Description |
|---|---|
static class |
ListSendersRequest.Builder |
static class |
ListSendersRequest.SortBy
The field to sort by.
|
| Constructor and Description |
|---|
ListSendersRequest() |
| Modifier and Type | Method and Description |
|---|---|
static ListSendersRequest.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 |
getDomain()
A filter to only return resources that match the given domain exactly.
|
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.
|
SortOrder |
getSortOrder()
The sort order to use, either ascending or descending order.
|
int |
hashCode()
Uses getInvocationCallback and getRetryConfiguration to generate a hash.
|
ListSendersRequest.Builder |
toBuilder()
Return an instance of
ListSendersRequest.Builder that allows you to modify request properties. |
String |
toString() |
getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continuepublic 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 getDomain()
A filter to only return resources that match the given domain exactly.
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 SortOrder getSortOrder()
The sort order to use, either ascending or descending order.
public ListSendersRequest.Builder toBuilder()
Return an instance of ListSendersRequest.Builder that allows you to modify request properties.
ListSendersRequest.Builder that allows you to modify request properties.public static ListSendersRequest.Builder builder()
Return a new builder for this request object.
public boolean equals(Object o)
BmcRequestUses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
equals in class BmcRequest<Void>public int hashCode()
BmcRequestUses getInvocationCallback and getRetryConfiguration to generate a hash.
hashCode in class BmcRequest<Void>Copyright © 2016–2024. All rights reserved.