com.oracle.bmc.loganalytics.requests

Class ListFieldsRequest

java.lang.Object

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

com.oracle.bmc.loganalytics.requests.ListFieldsRequest

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

Example: Click here to see how to use ListFieldsRequest.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ListFieldsRequest.Builder
static class	ListFieldsRequest.ParserType The parser type used for filtering.
static class	ListFieldsRequest.SortBy The attribute used to sort the returned fields
static class	ListFieldsRequest.SortOrder The sort order to use, either ascending (ASC) or descending (DESC).

Constructor Summary

Constructors

Constructor and Description
ListFieldsRequest()

Method Summary

Modifier and Type	Method and Description
static ListFieldsRequest.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	getFilter() filter
Boolean	getIsIncludeParser() isIncludeParser
Boolean	getIsMatchAll() A flag indicating how to handle filtering when multiple filter criteria are specified.
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.
String	getParserIds() A list of parser names used for filtering.
String	getParserNames() A list of parser names used for filtering.
ListFieldsRequest.ParserType	getParserType() The parser type used for filtering.
ListFieldsRequest.SortBy	getSortBy() The attribute used to sort the returned fields
ListFieldsRequest.SortOrder	getSortOrder() The sort order to use, either ascending (ASC) or descending (DESC).
String	getSourceIds() A list of source IDs used for filtering.
String	getSourceNames() A list of source names used for filtering.
int	hashCode() Uses getInvocationCallback and getRetryConfiguration to generate a hash.
ListFieldsRequest.Builder	toBuilder() Return an instance of ListFieldsRequest.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

ListFieldsRequest

public ListFieldsRequest()

Method Detail

getNamespaceName

public String getNamespaceName()

The Logging Analytics namespace used for the request.

getIsMatchAll

public Boolean getIsMatchAll()

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.

getSourceIds

public String getSourceIds()

A list of source IDs used for filtering. Only fields used by the specified sources will be returned.

getSourceNames

public String getSourceNames()

A list of source names used for filtering. Only fields used by the specified sources will be returned.

getParserType

public ListFieldsRequest.ParserType getParserType()

The parser type used for filtering. Only items with, or associated with, parsers of the specified type will be returned.

getParserIds

public String getParserIds()

A list of parser names used for filtering. Only fields used by the specified parsers will be returned.

getParserNames

public String getParserNames()

A list of parser names used for filtering. Only fields used by the specified parsers will be returned.

getIsIncludeParser

public Boolean getIsIncludeParser()

isIncludeParser

getFilter

public String getFilter()

filter

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 ListFieldsRequest.SortOrder getSortOrder()

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

getSortBy

public ListFieldsRequest.SortBy getSortBy()

The attribute used to sort the returned fields

getOpcRequestId

public String getOpcRequestId()

The client request ID for tracing.

toBuilder

public ListFieldsRequest.Builder toBuilder()

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

Returns:

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

builder

public static ListFieldsRequest.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>