Package com.oracle.bmc.email.requests

Class ListEmailReturnPathsRequest

java.lang.Object

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

com.oracle.bmc.email.requests.ListEmailReturnPathsRequest

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

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

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ListEmailReturnPathsRequest.Builder
static class	ListEmailReturnPathsRequest.SortBy	Specifies the attribute with which to sort the return paths.

Constructor Summary

Constructors

Constructor	Description
ListEmailReturnPathsRequest()

Method Summary

Modifier and Type	Method	Description
static ListEmailReturnPathsRequest.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	getId()	A filter to only return resources that match the given id exactly.
EmailReturnPath.LifecycleState	getLifecycleState()	Filter returned list by specified lifecycle state.
Integer	getLimit()	For list pagination.
String	getName()	A filter to only return resources that match the given name exactly.
String	getOpcRequestId()	The request ID for tracing from the system
String	getPage()	For list pagination.
String	getParentResourceId()	The OCID of the Email Domain to which this Email Return Path belongs.
ListEmailReturnPathsRequest.SortBy	getSortBy()	Specifies the attribute with which to sort the return paths.
SortOrder	getSortOrder()	The sort order to use, either ascending or descending order.
int	hashCode()	Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListEmailReturnPathsRequest.Builder	toBuilder()	Return an instance of ListEmailReturnPathsRequest.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

ListEmailReturnPathsRequest

public ListEmailReturnPathsRequest()

Method Detail

getOpcRequestId

public String getOpcRequestId()

The request ID for tracing from the system

getCompartmentId

public String getCompartmentId()

The OCID for the compartment.

getParentResourceId

public String getParentResourceId()

The OCID of the Email Domain to which this Email Return Path belongs.

getId

public String getId()

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

getName

public String getName()

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

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.

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.

getSortOrder

public SortOrder getSortOrder()

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

getLifecycleState

public EmailReturnPath.LifecycleState getLifecycleState()

Filter returned list by specified lifecycle state.

This parameter is case-insensitive.

getSortBy

public ListEmailReturnPathsRequest.SortBy getSortBy()

Specifies the attribute with which to sort the return paths.

Default: TIMECREATED

**TIMECREATED:** Sorts by timeCreated. * **NAME:** Sorts by name. * **ID:** Sorts by id.

toBuilder

public ListEmailReturnPathsRequest.Builder toBuilder()

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

Returns:

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

builder

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