com.oracle.bmc.email.requests

Class ListDkimsRequest.Builder

java.lang.Object

com.oracle.bmc.email.requests.ListDkimsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListDkimsRequest,Void>

Enclosing class:

ListDkimsRequest

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

Method Summary

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

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

Specified by:

copy in interface BmcRequest.Builder<ListDkimsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListDkimsRequest build()

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

Returns:

instance of ListDkimsRequest

emailDomainId

public ListDkimsRequest.Builder emailDomainId(String emailDomainId)

The OCID of the email domain to which this DKIM belongs.

Returns:

this.

opcRequestId

public ListDkimsRequest.Builder opcRequestId(String opcRequestId)

The request ID for tracing from the system

Returns:

this.

id

public ListDkimsRequest.Builder id(String id)

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

Returns:

this.

name

public ListDkimsRequest.Builder name(String name)

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

Returns:

this.

limit

public ListDkimsRequest.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 ListDkimsRequest.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 ListDkimsRequest.Builder sortOrder(SortOrder sortOrder)

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

Returns:

this.

lifecycleState

public ListDkimsRequest.Builder lifecycleState(Dkim.LifecycleState lifecycleState)

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

Returns:

this.

sortBy

public ListDkimsRequest.Builder sortBy(ListDkimsRequest.SortBy sortBy)

Specifies the attribute with which to sort the DKIMs.

Default: TIMECREATED

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

Returns:

this.

buildWithoutInvocationCallback

public ListDkimsRequest buildWithoutInvocationCallback()

toString

public String toString()

Overrides:

toString in class Object