Package com.oracle.bmc.email.requests

Class ListEmailDomainsRequest.Builder

java.lang.Object

com.oracle.bmc.email.requests.ListEmailDomainsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListEmailDomainsRequest,Void>

Enclosing class:

ListEmailDomainsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListEmailDomainsRequest	build()	Build the instance of ListEmailDomainsRequest as configured by this builder
ListEmailDomainsRequest	buildWithoutInvocationCallback()	Build the instance of ListEmailDomainsRequest as configured by this builder
ListEmailDomainsRequest.Builder	compartmentId(String compartmentId)	The OCID for the compartment.
ListEmailDomainsRequest.Builder	copy(ListEmailDomainsRequest o)	Copy method to populate the builder with values from the given instance.
ListEmailDomainsRequest.Builder	id(String id)	A filter to only return resources that match the given id exactly.
ListEmailDomainsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListEmailDomainsRequest.Builder	lifecycleState(EmailDomain.LifecycleState lifecycleState)	Filter returned list by specified lifecycle state.
ListEmailDomainsRequest.Builder	limit(Integer limit)	For list pagination.
ListEmailDomainsRequest.Builder	name(String name)	A filter to only return resources that match the given name exactly.
ListEmailDomainsRequest.Builder	opcRequestId(String opcRequestId)	The request ID for tracing from the system
ListEmailDomainsRequest.Builder	page(String page)	For list pagination.
ListEmailDomainsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListEmailDomainsRequest.Builder	sortBy(ListEmailDomainsRequest.SortBy sortBy)	Specifies the attribute with which to sort the email domains.
ListEmailDomainsRequest.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 ListEmailDomainsRequest.Builder compartmentId(String compartmentId)

The OCID for the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

opcRequestId

public ListEmailDomainsRequest.Builder opcRequestId(String opcRequestId)

The request ID for tracing from the system

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

id

public ListEmailDomainsRequest.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 ListEmailDomainsRequest.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 ListEmailDomainsRequest.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 ListEmailDomainsRequest.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 ListEmailDomainsRequest.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 ListEmailDomainsRequest.Builder lifecycleState(EmailDomain.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 ListEmailDomainsRequest.Builder sortBy(ListEmailDomainsRequest.SortBy sortBy)

Specifies the attribute with which to sort the email domains.

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

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

Specified by:

copy in interface BmcRequest.Builder<ListEmailDomainsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListEmailDomainsRequest build()

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

Returns:

instance of ListEmailDomainsRequest

buildWithoutInvocationCallback

public ListEmailDomainsRequest buildWithoutInvocationCallback()

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