com.oracle.bmc.events.requests

Class ListRulesRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest

com.oracle.bmc.events.requests.ListRulesRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20181201")
public class ListRulesRequest
extends BmcRequest

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListRulesRequest.Builder
static class	ListRulesRequest.SortBy Specifies the attribute with which to sort the rules.
static class	ListRulesRequest.SortOrder Specifies sort order.

Method Summary

Modifier and Type	Method and Description
static ListRulesRequest.Builder	builder()
String	getCompartmentId() The OCID of the compartment to which this rule belongs.
String	getDisplayName() A filter to return only rules with descriptions that match the displayName string in this parameter.
Rule.LifecycleState	getLifecycleState() A filter to return only rules that match the lifecycle state in this parameter.
Integer	getLimit() The maximum number of items to return.
String	getOpcRequestId() The unique Oracle-assigned identifier for the request.
String	getPage() For list pagination.
ListRulesRequest.SortBy	getSortBy() Specifies the attribute with which to sort the rules.
ListRulesRequest.SortOrder	getSortOrder() Specifies sort order.

Methods inherited from class com.oracle.bmc.requests.BmcRequest

getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

builder

public static ListRulesRequest.Builder builder()

getCompartmentId

public String getCompartmentId()

The OCID of the compartment to which this rule belongs.

getLimit

public Integer getLimit()

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

getPage

public String getPage()

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.

getLifecycleState

public Rule.LifecycleState getLifecycleState()

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

Example: Creating

getDisplayName

public String getDisplayName()

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

getSortBy

public ListRulesRequest.SortBy getSortBy()

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.

getSortOrder

public ListRulesRequest.SortOrder getSortOrder()

Specifies sort order.

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

getOpcRequestId

public String getOpcRequestId()

The unique Oracle-assigned identifier for the request. If you need to contact Oracle about a particular request, please provide the request ID.