Package com.oracle.bmc.events.requests

Class ListRulesRequest.Builder

java.lang.Object

com.oracle.bmc.events.requests.ListRulesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListRulesRequest,Void>

Enclosing class:

ListRulesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListRulesRequest	build()	Build the instance of ListRulesRequest as configured by this builder
ListRulesRequest	buildWithoutInvocationCallback()	Build the instance of ListRulesRequest as configured by this builder
ListRulesRequest.Builder	compartmentId(String compartmentId)	The OCID of the compartment to which this rule belongs.
ListRulesRequest.Builder	copy(ListRulesRequest o)	Copy method to populate the builder with values from the given instance.
ListRulesRequest.Builder	displayName(String displayName)	A filter to return only rules with descriptions that match the displayName string in this parameter.
ListRulesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListRulesRequest.Builder	lifecycleState(Rule.LifecycleState lifecycleState)	A filter to return only rules that match the lifecycle state in this parameter.
ListRulesRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListRulesRequest.Builder	opcRequestId(String opcRequestId)	The unique Oracle-assigned identifier for the request.
ListRulesRequest.Builder	page(String page)	For list pagination.
ListRulesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListRulesRequest.Builder	sortBy(ListRulesRequest.SortBy sortBy)	Specifies the attribute with which to sort the rules.
ListRulesRequest.Builder	sortOrder(ListRulesRequest.SortOrder sortOrder)	Specifies sort 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 ListRulesRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment to which this rule belongs.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

limit

public ListRulesRequest.Builder limit(Integer limit)

The maximum number of items to return.

1 is the minimum, 50 is the maximum. Default: 10

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListRulesRequest.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

lifecycleState

public ListRulesRequest.Builder lifecycleState(Rule.LifecycleState lifecycleState)

A filter to return only rules that match the lifecycle state in this parameter.

Example: Creating

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

displayName

public ListRulesRequest.Builder displayName(String displayName)

A filter to return only rules with descriptions that match the displayName string in this parameter.

Example: "This rule sends a notification upon completion of DbaaS backup."

Parameters:

displayName - the value to set

Returns:

this builder instance

sortBy

public ListRulesRequest.Builder sortBy(ListRulesRequest.SortBy sortBy)

Specifies the attribute with which to sort the rules.

Default: timeCreated

**TIME_CREATED:** Sorts by timeCreated. * **DISPLAY_NAME:** Sorts by displayName. * **ID:** Sorts by id.

Parameters:

sortBy - the value to set

Returns:

this builder instance

sortOrder

public ListRulesRequest.Builder sortOrder(ListRulesRequest.SortOrder sortOrder)

Specifies sort order.

**ASC:** Ascending sort order. * **DESC:** Descending sort order.

Parameters:

sortOrder - the value to set

Returns:

this builder instance

opcRequestId

public ListRulesRequest.Builder opcRequestId(String opcRequestId)

The unique Oracle-assigned identifier for the request.

If you need to contact Oracle about a particular request, please provide the request ID.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListRulesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListRulesRequest build()

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

Returns:

instance of ListRulesRequest

buildWithoutInvocationCallback

public ListRulesRequest buildWithoutInvocationCallback()

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