public static class ListSuppressionsRequest.Builder extends Object implements BmcRequest.Builder<ListSuppressionsRequest,Void>
Modifier and Type | Method and Description |
---|---|
ListSuppressionsRequest |
build()
Build the instance of ListSuppressionsRequest as configured by this builder
|
ListSuppressionsRequest |
buildWithoutInvocationCallback() |
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(Consumer<javax.ws.rs.client.Invocation.Builder> 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).
|
String |
toString() |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
body$
public ListSuppressionsRequest.Builder invocationCallback(Consumer<javax.ws.rs.client.Invocation.Builder> invocationCallback)
Set the invocation callback for the request to be built.
invocationCallback
- the invocation callback to be set for the requestpublic ListSuppressionsRequest.Builder retryConfiguration(RetryConfiguration retryConfiguration)
Set the retry configuration for the request to be built.
retryConfiguration
- the retry configuration to be used for the requestpublic ListSuppressionsRequest.Builder copy(ListSuppressionsRequest o)
Copy method to populate the builder with values from the given instance.
copy
in interface BmcRequest.Builder<ListSuppressionsRequest,Void>
o
- other request from which to copy valuespublic ListSuppressionsRequest build()
Build the instance of ListSuppressionsRequest 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.
build
in interface BmcRequest.Builder<ListSuppressionsRequest,Void>
public ListSuppressionsRequest.Builder compartmentId(String compartmentId)
The OCID for the compartment.
this
.public ListSuppressionsRequest.Builder opcRequestId(String opcRequestId)
The request ID for tracing from the system
this
.public ListSuppressionsRequest.Builder emailAddress(String emailAddress)
The email address of the suppression.
this
.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
this
.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
this
.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.
this
.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.
this
.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.
this
.public ListSuppressionsRequest.Builder sortOrder(SortOrder sortOrder)
The sort order to use, either ascending or descending order.
this
.public ListSuppressionsRequest buildWithoutInvocationCallback()
Copyright © 2016–2022. All rights reserved.