com.oracle.bmc.events.requests

Class ListRulesRequest.Builder

java.lang.Object

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

All Implemented Interfaces:

com.oracle.bmc.requests.BmcRequest.Builder<ListRulesRequest,Void>

Enclosing class:

ListRulesRequest

public static class ListRulesRequest.Builder
extends Object
implements com.oracle.bmc.requests.BmcRequest.Builder<ListRulesRequest,Void>

Method Summary

Modifier and Type	Method and Description
ListRulesRequest	build() Build the instance of ListRulesRequest as configured by this builder
ListRulesRequest	buildWithoutInvocationCallback()
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.util.internal.Consumer<javax.ws.rs.client.Invocation.Builder> 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(com.oracle.bmc.retrier.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.
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 ListRulesRequest.Builder invocationCallback(com.oracle.bmc.util.internal.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 ListRulesRequest.Builder retryConfiguration(com.oracle.bmc.retrier.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 com.oracle.bmc.requests.BmcRequest.Builder<ListRulesRequest,Void>

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.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 com.oracle.bmc.requests.BmcRequest.Builder<ListRulesRequest,Void>

Returns:

instance of ListRulesRequest

compartmentId

public ListRulesRequest.Builder compartmentId(String compartmentId)

The OCID of the compartment to which this rule belongs.

Returns:

this.

limit

public ListRulesRequest.Builder limit(Integer limit)

The maximum number of items to return. 1 is the minimum, 50 is the maximum. Default: 10

Returns:

this.

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.

Returns:

this.

lifecycleState

public ListRulesRequest.Builder lifecycleState(Rule.LifecycleState lifecycleState)

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

Example: `Creating`

Returns:

this.

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.\"`

Returns:

this.

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.

Returns:

this.

sortOrder

public ListRulesRequest.Builder sortOrder(ListRulesRequest.SortOrder sortOrder)

Specifies sort order.

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

Returns:

this.

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.

Returns:

this.

buildWithoutInvocationCallback

public ListRulesRequest buildWithoutInvocationCallback()

toString

public String toString()

Overrides:

toString in class Object