com.oracle.bmc.email.requests

Class ListSuppressionsRequest.Builder

java.lang.Object

com.oracle.bmc.email.requests.ListSuppressionsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListSuppressionsRequest,Void>

Enclosing class:

ListSuppressionsRequest

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

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
ListSuppressionsRequest	build() Build the instance of ListSuppressionsRequest as configured by this builder
ListSuppressionsRequest	buildWithoutInvocationCallback() Build the instance of ListSuppressionsRequest as configured by this builder
ListSuppressionsRequest.Builder	compartmentId(String compartmentId) The OCID for the compartment.
ListSuppressionsRequest.Builder	copy(ListSuppressionsRequest o) Copy method to populate the builder with values from the given instance.
ListSuppressionsRequest.Builder	emailAddress(String emailAddress) The email address of the suppression.
ListSuppressionsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback) Set the invocation callback for the request to be built.
ListSuppressionsRequest.Builder	limit(Integer limit) For list pagination.
ListSuppressionsRequest.Builder	opcRequestId(String opcRequestId) The request ID for tracing from the system
ListSuppressionsRequest.Builder	page(String page) For list pagination.
ListSuppressionsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration) Set the retry configuration for the request to be built.
ListSuppressionsRequest.Builder	sortBy(ListSuppressionsRequest.SortBy sortBy) The field to sort by.
ListSuppressionsRequest.Builder	sortOrder(SortOrder sortOrder) The sort order to use, either ascending or descending order.
ListSuppressionsRequest.Builder	timeCreatedGreaterThanOrEqualTo(Date timeCreatedGreaterThanOrEqualTo) Search for suppressions that were created within a specific date range, using this parameter to specify the earliest creation date for the returned list (inclusive).
ListSuppressionsRequest.Builder	timeCreatedLessThan(Date timeCreatedLessThan) Search for suppressions that were created within a specific date range, using this parameter to specify the latest creation date for the returned list (exclusive).

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 ListSuppressionsRequest.Builder compartmentId(String compartmentId)

The OCID for the compartment.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

opcRequestId

public ListSuppressionsRequest.Builder opcRequestId(String opcRequestId)

The request ID for tracing from the system

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

emailAddress

public ListSuppressionsRequest.Builder emailAddress(String emailAddress)

The email address of the suppression.

Parameters:

emailAddress - the value to set

Returns:

this builder instance

timeCreatedGreaterThanOrEqualTo

public ListSuppressionsRequest.Builder timeCreatedGreaterThanOrEqualTo(Date timeCreatedGreaterThanOrEqualTo)

Search for suppressions that were created within a specific date range, using this parameter to specify the earliest creation date for the returned list (inclusive). Specifying this parameter without the corresponding timeCreatedLessThan parameter will retrieve suppressions created from the given timeCreatedGreaterThanOrEqualTo to the current time, in “YYYY-MM-ddThh:mmZ” format with a Z offset, as defined by RFC 3339.

*Example:** 2016-12-19T16:39:57.600Z

Parameters:

timeCreatedGreaterThanOrEqualTo - the value to set

Returns:

this builder instance

timeCreatedLessThan

public ListSuppressionsRequest.Builder timeCreatedLessThan(Date timeCreatedLessThan)

Search for suppressions that were created within a specific date range, using this parameter to specify the latest creation date for the returned list (exclusive). Specifying this parameter without the corresponding timeCreatedGreaterThanOrEqualTo parameter will retrieve all suppressions created before the specified end date, in “YYYY-MM-ddThh:mmZ” format with a Z offset, as defined by RFC 3339.

*Example:** 2016-12-19T16:39:57.600Z

Parameters:

timeCreatedLessThan - the value to set

Returns:

this builder instance

page

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

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

Specified by:

copy in interface BmcRequest.Builder<ListSuppressionsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListSuppressionsRequest build()

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

Returns:

instance of ListSuppressionsRequest

buildWithoutInvocationCallback

public ListSuppressionsRequest buildWithoutInvocationCallback()

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