Package com.oracle.bmc.loganalytics.requests

Class ListCategoriesRequest.Builder

java.lang.Object

com.oracle.bmc.loganalytics.requests.ListCategoriesRequest.Builder

All Implemented Interfaces:

BmcRequest.Builder<ListCategoriesRequest,Void>

Enclosing class:

ListCategoriesRequest

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

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ListCategoriesRequest	build()	Build the instance of ListCategoriesRequest as configured by this builder
ListCategoriesRequest	buildWithoutInvocationCallback()	Build the instance of ListCategoriesRequest as configured by this builder
ListCategoriesRequest.Builder	categoryDisplayText(String categoryDisplayText)	The category display text used for filtering.
ListCategoriesRequest.Builder	categoryType(String categoryType)	A comma-separated list of category types used for filtering.
ListCategoriesRequest.Builder	copy(ListCategoriesRequest o)	Copy method to populate the builder with values from the given instance.
ListCategoriesRequest.Builder	invocationCallback(com.oracle.bmc.http.client.RequestInterceptor invocationCallback)	Set the invocation callback for the request to be built.
ListCategoriesRequest.Builder	limit(Integer limit)	The maximum number of items to return.
ListCategoriesRequest.Builder	name(String name)	A filter to return only log analytics entities whose name matches the entire name given.
ListCategoriesRequest.Builder	namespaceName(String namespaceName)	The Logging Analytics namespace used for the request.
ListCategoriesRequest.Builder	opcRequestId(String opcRequestId)	The client request ID for tracing.
ListCategoriesRequest.Builder	page(String page)	The page token representing the page at which to start retrieving results.
ListCategoriesRequest.Builder	retryConfiguration(RetryConfiguration retryConfiguration)	Set the retry configuration for the request to be built.
ListCategoriesRequest.Builder	sortBy(ListCategoriesRequest.SortBy sortBy)	The attribute used to sort the returned categories
ListCategoriesRequest.Builder	sortOrder(ListCategoriesRequest.SortOrder sortOrder)	The sort order to use, either ascending (ASC) or descending (DESC).

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 ListCategoriesRequest.Builder namespaceName(String namespaceName)

The Logging Analytics namespace used for the request.

Parameters:

namespaceName - the value to set

Returns:

this builder instance

categoryType

public ListCategoriesRequest.Builder categoryType(String categoryType)

A comma-separated list of category types used for filtering.

Only categories of the specified types will be returned.

Parameters:

categoryType - the value to set

Returns:

this builder instance

categoryDisplayText

public ListCategoriesRequest.Builder categoryDisplayText(String categoryDisplayText)

The category display text used for filtering.

Only categories matching the specified display name or description will be returned.

Parameters:

categoryDisplayText - the value to set

Returns:

this builder instance

sortOrder

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

The attribute used to sort the returned categories

Parameters:

sortBy - the value to set

Returns:

this builder instance

limit

public ListCategoriesRequest.Builder limit(Integer limit)

The maximum number of items to return.

Parameters:

limit - the value to set

Returns:

this builder instance

page

public ListCategoriesRequest.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

name

public ListCategoriesRequest.Builder name(String name)

A filter to return only log analytics entities whose name matches the entire name given.

The match is case-insensitive.

Parameters:

name - the value to set

Returns:

this builder instance

opcRequestId

public ListCategoriesRequest.Builder opcRequestId(String opcRequestId)

The client request ID for tracing.

Parameters:

opcRequestId - the value to set

Returns:

this builder instance

invocationCallback

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

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

Specified by:

copy in interface BmcRequest.Builder<ListCategoriesRequest,Void>

Parameters:

o - other request from which to copy values

Returns:

this builder instance

build

public ListCategoriesRequest build()

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

Returns:

instance of ListCategoriesRequest

buildWithoutInvocationCallback

public ListCategoriesRequest buildWithoutInvocationCallback()

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