Package com.oracle.bmc.loganalytics.requests

Class ListRulesRequest.Builder

java.lang.Object

com.oracle.bmc.loganalytics.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 ID of the compartment in which to list resources.
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 rules whose displayName matches in whole or in part the specified value.
ListRulesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListRulesRequest.Builder	kind(ListRulesRequest.Kind kind)	The rule kind used for filtering.
ListRulesRequest.Builder	lifecycleState(ConfigLifecycleState lifecycleState)	The rule lifecycle state used for filtering.
ListRulesRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListRulesRequest.Builder	namespaceName(String namespaceName)	The Logging Analytics namespace used for the request.
ListRulesRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListRulesRequest.Builder	page(String page)	The page token representing the page at which to start retrieving results.
ListRulesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListRulesRequest.Builder	sortBy(ListRulesRequest.SortBy sortBy)	The field to sort by.
ListRulesRequest.Builder	sortOrder(ListRulesRequest.SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (DESC).
ListRulesRequest.Builder	targetService(String targetService)	The target service to use for filtering.

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

namespaceName

public ListRulesRequest.Builder namespaceName(String namespaceName)

The Logging Analytics namespace used for the request.

Parameters:

namespaceName - the value to set

Returns:

this builder instance

compartmentId

public ListRulesRequest.Builder compartmentId(String compartmentId)

The ID of the compartment in which to list resources.

Parameters:

compartmentId - the value to set

Returns:

this builder instance

displayName

public ListRulesRequest.Builder displayName(String displayName)

A filter to return rules whose displayName matches in whole or in part the specified value.

The match is case-insensitive.

Parameters:

displayName - the value to set

Returns:

this builder instance

kind

public ListRulesRequest.Builder kind(ListRulesRequest.Kind kind)

The rule kind used for filtering.

Only rules of the specified kind will be returned.

Parameters:

kind - the value to set

Returns:

this builder instance

targetService

public ListRulesRequest.Builder targetService(String targetService)

The target service to use for filtering.

Parameters:

targetService - the value to set

Returns:

this builder instance

lifecycleState

public ListRulesRequest.Builder lifecycleState(ConfigLifecycleState lifecycleState)

The rule lifecycle state used for filtering.

Currently supported values are ACTIVE and DELETED.

Parameters:

lifecycleState - the value to set

Returns:

this builder instance

limit

public ListRulesRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListRulesRequest.Builder page(String page)

The page token representing the page at which to start retrieving results.

This is usually retrieved from a previous list call.

Parameters:

page - the value to set

Returns:

this builder instance

sortOrder

public ListRulesRequest.Builder sortOrder(ListRulesRequest.SortOrder sortOrder)

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

Parameters:

sortOrder - the value to set

Returns:

this builder instance

sortBy

public ListRulesRequest.Builder sortBy(ListRulesRequest.SortBy sortBy)

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.

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListRulesRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

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