Package com.oracle.bmc.loganalytics.requests

Class ListFieldsRequest.Builder

java.lang.Object

com.oracle.bmc.loganalytics.requests.ListFieldsRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListFieldsRequest,Void>

Enclosing class:

ListFieldsRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListFieldsRequest	build()	Build the instance of ListFieldsRequest as configured by this builder
ListFieldsRequest	buildWithoutInvocationCallback()	Build the instance of ListFieldsRequest as configured by this builder
ListFieldsRequest.Builder	copy(ListFieldsRequest o)	Copy method to populate the builder with values from the given instance.
ListFieldsRequest.Builder	filter(String filter)	filter
ListFieldsRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListFieldsRequest.Builder	isIncludeParser(Boolean isIncludeParser)	isIncludeParser
ListFieldsRequest.Builder	isMatchAll(Boolean isMatchAll)	A flag indicating how to handle filtering when multiple filter criteria are specified.
ListFieldsRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListFieldsRequest.Builder	namespaceName(String namespaceName)	The Logging Analytics namespace used for the request.
ListFieldsRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListFieldsRequest.Builder	page(String page)	The page token representing the page at which to start retrieving results.
ListFieldsRequest.Builder	parserIds(String parserIds)	A list of parser names used for filtering.
ListFieldsRequest.Builder	parserNames(String parserNames)	A list of parser names used for filtering.
ListFieldsRequest.Builder	parserType(ListFieldsRequest.ParserType parserType)	The parser type used for filtering.
ListFieldsRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListFieldsRequest.Builder	sortBy(ListFieldsRequest.SortBy sortBy)	The attribute used to sort the returned fields
ListFieldsRequest.Builder	sortOrder(ListFieldsRequest.SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (DESC).
ListFieldsRequest.Builder	sourceIds(String sourceIds)	A list of source IDs used for filtering.
ListFieldsRequest.Builder	sourceNames(String sourceNames)	A list of source names used 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 ListFieldsRequest.Builder namespaceName(String namespaceName)

The Logging Analytics namespace used for the request.

Parameters:

namespaceName - the value to set

Returns:

this builder instance

isMatchAll

public ListFieldsRequest.Builder isMatchAll(Boolean isMatchAll)

A flag indicating how to handle filtering when multiple filter criteria are specified.

A value of true will always result in the most expansive list of items being returned. For example, if two field lists are supplies as filter criteria, a value of true will result in any item matching a field in either list being returned, while a value of false will result in a list of items which only have fields contained in both input lists.

Parameters:

isMatchAll - the value to set

Returns:

this builder instance

sourceIds

public ListFieldsRequest.Builder sourceIds(String sourceIds)

A list of source IDs used for filtering.

Only fields used by the specified sources will be returned.

Parameters:

sourceIds - the value to set

Returns:

this builder instance

sourceNames

public ListFieldsRequest.Builder sourceNames(String sourceNames)

A list of source names used for filtering.

Only fields used by the specified sources will be returned.

Parameters:

sourceNames - the value to set

Returns:

this builder instance

parserType

public ListFieldsRequest.Builder parserType(ListFieldsRequest.ParserType parserType)

The parser type used for filtering.

Only items with, or associated with, parsers of the specified type will be returned.

Parameters:

parserType - the value to set

Returns:

this builder instance

parserIds

public ListFieldsRequest.Builder parserIds(String parserIds)

A list of parser names used for filtering.

Only fields used by the specified parsers will be returned.

Parameters:

parserIds - the value to set

Returns:

this builder instance

parserNames

public ListFieldsRequest.Builder parserNames(String parserNames)

A list of parser names used for filtering.

Only fields used by the specified parsers will be returned.

Parameters:

parserNames - the value to set

Returns:

this builder instance

isIncludeParser

public ListFieldsRequest.Builder isIncludeParser(Boolean isIncludeParser)

isIncludeParser

Parameters:

isIncludeParser - the value to set

Returns:

this builder instance

filter

public ListFieldsRequest.Builder filter(String filter)

filter

Parameters:

filter - the value to set

Returns:

this builder instance

limit

public ListFieldsRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListFieldsRequest.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 ListFieldsRequest.Builder sortOrder(ListFieldsRequest.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 ListFieldsRequest.Builder sortBy(ListFieldsRequest.SortBy sortBy)

The attribute used to sort the returned fields

Parameters:

sortBy - the value to set

Returns:

this builder instance

opcRequestId

public ListFieldsRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListFieldsRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListFieldsRequest build()

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

Returns:

instance of ListFieldsRequest

buildWithoutInvocationCallback

public ListFieldsRequest buildWithoutInvocationCallback()

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