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>

Method Summary

Modifier and Type	Method and Description
ListEmailDomainsRequest	build() Build the instance of ListEmailDomainsRequest as configured by this builder
ListEmailDomainsRequest	buildWithoutInvocationCallback()
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(Consumer<javax.ws.rs.client.Invocation.Builder> 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.
String	toString()

Methods inherited from class java.lang.Object

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

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

body$

Method Detail

invocationCallback

public ListEmailDomainsRequest.Builder invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> 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.util.internal.Consumer) 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

compartmentId

public ListEmailDomainsRequest.Builder compartmentId(String compartmentId)

The OCID for the compartment.

Returns:

this.

opcRequestId

public ListEmailDomainsRequest.Builder opcRequestId(String opcRequestId)

The request ID for tracing from the system

Returns:

this.

id

public ListEmailDomainsRequest.Builder id(String id)

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

Returns:

this.

name

public ListEmailDomainsRequest.Builder name(String name)

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

Returns:

this.

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.

Returns:

this.

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.

Returns:

this.

sortOrder

public ListEmailDomainsRequest.Builder sortOrder(SortOrder sortOrder)

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

Returns:

this.

lifecycleState

public ListEmailDomainsRequest.Builder lifecycleState(EmailDomain.LifecycleState lifecycleState)

Filter returned list by specified lifecycle state. This parameter is case-insensitive.

Returns:

this.

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.

Returns:

this.

buildWithoutInvocationCallback

public ListEmailDomainsRequest buildWithoutInvocationCallback()

toString

public String toString()

Overrides:

toString in class Object