Package com.oracle.bmc.email.requests

Class ListEmailReturnPathsRequest.Builder

java.lang.Object

com.oracle.bmc.email.requests.ListEmailReturnPathsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListEmailReturnPathsRequest,Void>

Enclosing class:

ListEmailReturnPathsRequest

public static class ListEmailReturnPathsRequest.Builder
extends Object
implements BmcRequest.Builder<ListEmailReturnPathsRequest,Void>

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListEmailReturnPathsRequest	build()	Build the instance of ListEmailReturnPathsRequest as configured by this builder
ListEmailReturnPathsRequest	buildWithoutInvocationCallback()	Build the instance of ListEmailReturnPathsRequest as configured by this builder
ListEmailReturnPathsRequest.Builder	compartmentId(String compartmentId)	The OCID for the compartment.
ListEmailReturnPathsRequest.Builder	copy(ListEmailReturnPathsRequest o)	Copy method to populate the builder with values from the given instance.
ListEmailReturnPathsRequest.Builder	id(String id)	A filter to only return resources that match the given id exactly.
ListEmailReturnPathsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListEmailReturnPathsRequest.Builder	lifecycleState(EmailReturnPath.LifecycleState lifecycleState)	Filter returned list by specified lifecycle state.
ListEmailReturnPathsRequest.Builder	limit(Integer limit)	For list pagination.
ListEmailReturnPathsRequest.Builder	name(String name)	A filter to only return resources that match the given name exactly.
ListEmailReturnPathsRequest.Builder	opcRequestId(String opcRequestId)	The request ID for tracing from the system
ListEmailReturnPathsRequest.Builder	page(String page)	For list pagination.
ListEmailReturnPathsRequest.Builder	parentResourceId(String parentResourceId)	The OCID of the Email Domain to which this Email Return Path belongs.
ListEmailReturnPathsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListEmailReturnPathsRequest.Builder	sortBy(ListEmailReturnPathsRequest.SortBy sortBy)	Specifies the attribute with which to sort the return paths.
ListEmailReturnPathsRequest.Builder	sortOrder(SortOrder sortOrder)	The sort order to use, either ascending or descending order.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.oracle.bmc.requests.BmcRequest.Builder

body$

Constructor Detail

Builder

public Builder()

Method Detail

opcRequestId

public ListEmailReturnPathsRequest.Builder opcRequestId(String opcRequestId)

The request ID for tracing from the system

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

compartmentId

public ListEmailReturnPathsRequest.Builder compartmentId(String compartmentId)

The OCID for the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

parentResourceId

public ListEmailReturnPathsRequest.Builder parentResourceId(String parentResourceId)

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

Parameters:

parentResourceId - the value to set

Returns:

this builder instance

id

public ListEmailReturnPathsRequest.Builder id(String id)

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

Parameters:

id - the value to set

Returns:

this builder instance

name

public ListEmailReturnPathsRequest.Builder name(String name)

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

Parameters:

name - the value to set

Returns:

this builder instance

limit

public ListEmailReturnPathsRequest.Builder limit(Integer limit)

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.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListEmailReturnPathsRequest.Builder page(String page)

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.

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListEmailReturnPathsRequest.Builder sortOrder(SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

lifecycleState

public ListEmailReturnPathsRequest.Builder lifecycleState(EmailReturnPath.LifecycleState lifecycleState)

Filter returned list by specified lifecycle state.

This parameter is case-insensitive.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

sortBy

public ListEmailReturnPathsRequest.Builder sortBy(ListEmailReturnPathsRequest.SortBy sortBy)

Specifies the attribute with which to sort the return paths.

Default: TIMECREATED

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

Parameters:

sortBy - the value to set

Returns:

this builder instance

invocationCallback

public ListEmailReturnPathsRequest.Builder invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)

Set the invocation callback for the request to be built.

Parameters:

invocationCallback - the invocation callback to be set for the request

Returns:

this builder instance

retryConfiguration

public ListEmailReturnPathsRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)

Set the retry configuration for the request to be built.

Parameters:

retryConfiguration - the retry configuration to be used for the request

Returns:

this builder instance

copy

public ListEmailReturnPathsRequest.Builder copy(ListEmailReturnPathsRequest o)

Copy method to populate the builder with values from the given instance.

Specified by:

copy in interface BmcRequest.Builder<ListEmailReturnPathsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListEmailReturnPathsRequest build()

Build the instance of ListEmailReturnPathsRequest as configured by this builder

Note that this method takes calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method buildWithoutInvocationCallback() does not.

This is the preferred method to build an instance.

Specified by:

build in interface BmcRequest.Builder<ListEmailReturnPathsRequest,Void>

Returns:

instance of ListEmailReturnPathsRequest

buildWithoutInvocationCallback

public ListEmailReturnPathsRequest buildWithoutInvocationCallback()

Build the instance of ListEmailReturnPathsRequest as configured by this builder

Note that this method does not take calls to invocationCallback(com.oracle.bmc.http.client.RequestInterceptor) into account, while the method build() does

Returns:

instance of ListEmailReturnPathsRequest