Package com.oracle.bmc.email.requests

Class ListSendersRequest

java.lang.Object

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

com.oracle.bmc.email.requests.ListSendersRequest

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

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

Nested Class Summary

Nested Classes

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

Constructor Summary

Constructors

Constructor	Description
ListSendersRequest()

Method Summary

Modifier and Type	Method	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()

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

ListSendersRequest

public ListSendersRequest()

Method Detail

getCompartmentId

public String getCompartmentId()

The OCID for the compartment.

getOpcRequestId

public String getOpcRequestId()

The request ID for tracing from the system

getLifecycleState

public Sender.LifecycleState getLifecycleState()

The current state of a sender.

getDomain

public String getDomain()

A filter to only return resources that match the given domain exactly.

getEmailAddress

public String getEmailAddress()

The email address of the approved sender.

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 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.

getSortOrder

public SortOrder getSortOrder()

The sort order to use, either ascending or descending order.

toBuilder

public ListSendersRequest.Builder toBuilder()

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

Returns:

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

builder

public static ListSendersRequest.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>