Package com.oracle.bmc.email.requests

Class ListSendersRequest.Builder

java.lang.Object

com.oracle.bmc.email.requests.ListSendersRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListSendersRequest,Void>

Enclosing class:

ListSendersRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListSendersRequest	build()	Build the instance of ListSendersRequest as configured by this builder
ListSendersRequest	buildWithoutInvocationCallback()	Build the instance of ListSendersRequest as configured by this builder
ListSendersRequest.Builder	compartmentId(String compartmentId)	The OCID for the compartment.
ListSendersRequest.Builder	copy(ListSendersRequest o)	Copy method to populate the builder with values from the given instance.
ListSendersRequest.Builder	domain(String domain)	A filter to only return resources that match the given domain exactly.
ListSendersRequest.Builder	emailAddress(String emailAddress)	The email address of the approved sender.
ListSendersRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListSendersRequest.Builder	lifecycleState(Sender.LifecycleState lifecycleState)	The current state of a sender.
ListSendersRequest.Builder	limit(Integer limit)	For list pagination.
ListSendersRequest.Builder	opcRequestId(String opcRequestId)	The request ID for tracing from the system
ListSendersRequest.Builder	page(String page)	For list pagination.
ListSendersRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListSendersRequest.Builder	sortBy(ListSendersRequest.SortBy sortBy)	The field to sort by.
ListSendersRequest.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

compartmentId

public ListSendersRequest.Builder compartmentId(String compartmentId)

The OCID for the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

opcRequestId

public ListSendersRequest.Builder opcRequestId(String opcRequestId)

The request ID for tracing from the system

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

lifecycleState

public ListSendersRequest.Builder lifecycleState(Sender.LifecycleState lifecycleState)

The current state of a sender.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

domain

public ListSendersRequest.Builder domain(String domain)

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

Parameters:

domain - the value to set

Returns:

this builder instance

emailAddress

public ListSendersRequest.Builder emailAddress(String emailAddress)

The email address of the approved sender.

Parameters:

emailAddress - the value to set

Returns:

this builder instance

page

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

limit

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

sortBy

public ListSendersRequest.Builder sortBy(ListSendersRequest.SortBy sortBy)

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.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListSendersRequest.Builder sortOrder(SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

invocationCallback

public ListSendersRequest.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 ListSendersRequest.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 ListSendersRequest.Builder copy(ListSendersRequest o)

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

Specified by:

copy in interface BmcRequest.Builder<ListSendersRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListSendersRequest build()

Build the instance of ListSendersRequest 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<ListSendersRequest,Void>

Returns:

instance of ListSendersRequest

buildWithoutInvocationCallback

public ListSendersRequest buildWithoutInvocationCallback()

Build the instance of ListSendersRequest 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 ListSendersRequest