com.oracle.bmc.loganalytics.requests

Class ListRulesRequest

java.lang.Object

com.oracle.bmc.requests.BmcRequest<Void>

com.oracle.bmc.loganalytics.requests.ListRulesRequest

@Generated(value="OracleSDKGenerator",
           comments="API Version: 20200601")
public class ListRulesRequest
extends BmcRequest<Void>

Example: Click here to see how to use ListRulesRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListRulesRequest.Builder
static class	ListRulesRequest.Kind The rule kind used for filtering.
static class	ListRulesRequest.SortBy The field to sort by.
static class	ListRulesRequest.SortOrder The sort order to use, either ascending (ASC) or descending (DESC).

Constructor Summary

Constructors

Constructor and Description
ListRulesRequest()

Method Summary

Modifier and Type	Method and Description
static ListRulesRequest.Builder	builder() Return a new builder for this request object.
boolean	equals(Object o) Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.
String	getCompartmentId() The ID of the compartment in which to list resources.
String	getDisplayName() A filter to return rules whose displayName matches in whole or in part the specified value.
ListRulesRequest.Kind	getKind() The rule kind used for filtering.
ConfigLifecycleState	getLifecycleState() The rule lifecycle state used for filtering.
Integer	getLimit() The maximum number of items to return.
String	getNamespaceName() The Logging Analytics namespace used for the request.
String	getOpcRequestId() The client request ID for tracing.
String	getPage() The page token representing the page at which to start retrieving results.
ListRulesRequest.SortBy	getSortBy() The field to sort by.
ListRulesRequest.SortOrder	getSortOrder() The sort order to use, either ascending (ASC) or descending (DESC).
String	getTargetService() The target service to use for filtering.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListRulesRequest.Builder	toBuilder() Return an instance of ListRulesRequest.Builder that allows you to modify request properties.
String	toString()

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

getBody$, getInvocationCallback, getRetryConfiguration, setInvocationCallback, setRetryConfiguration, supportsExpect100Continue

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

ListRulesRequest

public ListRulesRequest()

Method Detail

getNamespaceName

public String getNamespaceName()

The Logging Analytics namespace used for the request.

getCompartmentId

public String getCompartmentId()

The ID of the compartment in which to list resources.

getDisplayName

public String getDisplayName()

A filter to return rules whose displayName matches in whole or in part the specified value. The match is case-insensitive.

getKind

public ListRulesRequest.Kind getKind()

The rule kind used for filtering. Only rules of the specified kind will be returned.

getTargetService

public String getTargetService()

The target service to use for filtering.

getLifecycleState

public ConfigLifecycleState getLifecycleState()

The rule lifecycle state used for filtering. Currently supported values are ACTIVE and DELETED.

getLimit

public Integer getLimit()

The maximum number of items to return.

getPage

public String getPage()

The page token representing the page at which to start retrieving results. This is usually retrieved from a previous list call.

getSortOrder

public ListRulesRequest.SortOrder getSortOrder()

The sort order to use, either ascending (ASC) or descending (DESC).

getSortBy

public ListRulesRequest.SortBy getSortBy()

The field to sort by. Only one sort order may be provided. Default order for timeCreated is descending. Default order for displayName is ascending. If no value is specified timeCreated is default.

getOpcRequestId

public String getOpcRequestId()

The client request ID for tracing.

toBuilder

public ListRulesRequest.Builder toBuilder()

Return an instance of ListRulesRequest.Builder that allows you to modify request properties.

Returns:

instance of ListRulesRequest.Builder that allows you to modify request properties.

builder

public static ListRulesRequest.Builder builder()

Return a new builder for this request object.

Returns:

builder for the request object

toString

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object o)

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to determine if passed request is equal to ‘this’.

Overrides:

equals in class BmcRequest<Void>

hashCode

public int hashCode()

Description copied from class: BmcRequest

Uses getInvocationCallback and getRetryConfiguration to generate a hash.

Overrides:

hashCode in class BmcRequest<Void>